Microsoft.DataFactory factories/linkedservices 2018-06-01
Bicep resource definition
The factories/linkedservices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories/linkedservices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataFactory/factories/linkedservices@2018-06-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
annotations: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
connectVia: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
description: 'string'
parameters: {
{customized property}: {
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
version: 'string'
type: 'string'
// For remaining properties, see LinkedService objects
}
}
LinkedService objects
Set the type property to specify the type of object.
For AmazonMWS, use:
{
type: 'AmazonMWS'
typeProperties: {
accessKeyId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
marketplaceID: any(Azure.Bicep.Types.Concrete.AnyType)
mwsAuthToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
secretKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
sellerID: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonRdsForOracle, use:
{
type: 'AmazonRdsForOracle'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
For AmazonRdsForSqlServer, use:
{
type: 'AmazonRdsForSqlServer'
typeProperties: {
alwaysEncryptedSettings: {
alwaysEncryptedAkvAuthType: 'string'
credential: {
referenceName: 'string'
type: 'string'
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
applicationIntent: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryInterval: any(Azure.Bicep.Types.Concrete.AnyType)
connectTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
encrypt: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
failoverPartner: any(Azure.Bicep.Types.Concrete.AnyType)
hostNameInCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
integratedSecurity: any(Azure.Bicep.Types.Concrete.AnyType)
loadBalanceTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
maxPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
minPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
multipleActiveResultSets: any(Azure.Bicep.Types.Concrete.AnyType)
multiSubnetFailover: any(Azure.Bicep.Types.Concrete.AnyType)
packetSize: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonRedshift, use:
{
type: 'AmazonRedshift'
typeProperties: {
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonS3, use:
{
type: 'AmazonS3'
typeProperties: {
accessKeyId: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
secretAccessKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
serviceUrl: any(Azure.Bicep.Types.Concrete.AnyType)
sessionToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
For AmazonS3Compatible, use:
{
type: 'AmazonS3Compatible'
typeProperties: {
accessKeyId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
forcePathStyle: any(Azure.Bicep.Types.Concrete.AnyType)
secretAccessKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
serviceUrl: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AppFigures, use:
{
type: 'AppFigures'
typeProperties: {
clientKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Asana, use:
{
type: 'Asana'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
}
}
For AzureBatch, use:
{
type: 'AzureBatch'
typeProperties: {
accessKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
accountName: any(Azure.Bicep.Types.Concrete.AnyType)
batchUri: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
poolName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureBlobFS, use:
{
type: 'AzureBlobFS'
typeProperties: {
accountKey: any(Azure.Bicep.Types.Concrete.AnyType)
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
sasToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
sasUri: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
url: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureBlobStorage, use:
{
type: 'AzureBlobStorage'
typeProperties: {
accountKey: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
accountKind: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
containerUri: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
sasToken: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
sasUri: any(Azure.Bicep.Types.Concrete.AnyType)
serviceEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDataExplorer, use:
{
type: 'AzureDataExplorer'
typeProperties: {
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDataLakeAnalytics, use:
{
type: 'AzureDataLakeAnalytics'
typeProperties: {
accountName: any(Azure.Bicep.Types.Concrete.AnyType)
dataLakeAnalyticsUri: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
resourceGroupName: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
subscriptionId: any(Azure.Bicep.Types.Concrete.AnyType)
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDataLakeStore, use:
{
type: 'AzureDataLakeStore'
typeProperties: {
accountName: any(Azure.Bicep.Types.Concrete.AnyType)
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
dataLakeStoreUri: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
resourceGroupName: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
subscriptionId: any(Azure.Bicep.Types.Concrete.AnyType)
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDatabricks, use:
{
type: 'AzureDatabricks'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
authentication: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
domain: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
existingClusterId: any(Azure.Bicep.Types.Concrete.AnyType)
instancePoolId: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterCustomTags: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
newClusterDriverNodeType: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterEnableElasticDisk: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterInitScripts: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterLogDestination: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterNodeType: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterNumOfWorker: any(Azure.Bicep.Types.Concrete.AnyType)
newClusterSparkConf: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
newClusterSparkEnvVars: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
newClusterVersion: any(Azure.Bicep.Types.Concrete.AnyType)
policyId: any(Azure.Bicep.Types.Concrete.AnyType)
workspaceResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDatabricksDeltaLake, use:
{
type: 'AzureDatabricksDeltaLake'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
clusterId: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
domain: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
workspaceResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureFileStorage, use:
{
type: 'AzureFileStorage'
typeProperties: {
accountKey: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
fileShare: any(Azure.Bicep.Types.Concrete.AnyType)
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
sasToken: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
sasUri: any(Azure.Bicep.Types.Concrete.AnyType)
serviceEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
snapshot: any(Azure.Bicep.Types.Concrete.AnyType)
userId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureFunction, use:
{
type: 'AzureFunction'
typeProperties: {
authentication: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
functionAppUrl: any(Azure.Bicep.Types.Concrete.AnyType)
functionKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
resourceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureKeyVault, use:
{
type: 'AzureKeyVault'
typeProperties: {
baseUrl: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
}
}
For AzureML, use:
{
type: 'AzureML'
typeProperties: {
apiKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
authentication: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
mlEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
updateResourceEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureMLService, use:
{
type: 'AzureMLService'
typeProperties: {
authentication: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
mlWorkspaceName: any(Azure.Bicep.Types.Concrete.AnyType)
resourceGroupName: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
subscriptionId: any(Azure.Bicep.Types.Concrete.AnyType)
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureMariaDB, use:
{
type: 'AzureMariaDB'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
pwd: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For AzureMySql, use:
{
type: 'AzureMySql'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For AzurePostgreSql, use:
{
type: 'AzurePostgreSql'
typeProperties: {
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
encoding: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
readBufferSize: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
sslMode: any(Azure.Bicep.Types.Concrete.AnyType)
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
timezone: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSearch, use:
{
type: 'AzureSearch'
typeProperties: {
encryptedCredential: 'string'
key: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlDW, use:
{
type: 'AzureSqlDW'
typeProperties: {
applicationIntent: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryInterval: any(Azure.Bicep.Types.Concrete.AnyType)
connectTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encrypt: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
failoverPartner: any(Azure.Bicep.Types.Concrete.AnyType)
hostNameInCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
integratedSecurity: any(Azure.Bicep.Types.Concrete.AnyType)
loadBalanceTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
maxPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
minPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
multipleActiveResultSets: any(Azure.Bicep.Types.Concrete.AnyType)
multiSubnetFailover: any(Azure.Bicep.Types.Concrete.AnyType)
packetSize: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlDatabase, use:
{
type: 'AzureSqlDatabase'
typeProperties: {
alwaysEncryptedSettings: {
alwaysEncryptedAkvAuthType: 'string'
credential: {
referenceName: 'string'
type: 'string'
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
applicationIntent: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryInterval: any(Azure.Bicep.Types.Concrete.AnyType)
connectTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encrypt: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
failoverPartner: any(Azure.Bicep.Types.Concrete.AnyType)
hostNameInCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
integratedSecurity: any(Azure.Bicep.Types.Concrete.AnyType)
loadBalanceTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
maxPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
minPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
multipleActiveResultSets: any(Azure.Bicep.Types.Concrete.AnyType)
multiSubnetFailover: any(Azure.Bicep.Types.Concrete.AnyType)
packetSize: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlMI, use:
{
type: 'AzureSqlMI'
typeProperties: {
alwaysEncryptedSettings: {
alwaysEncryptedAkvAuthType: 'string'
credential: {
referenceName: 'string'
type: 'string'
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
applicationIntent: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryInterval: any(Azure.Bicep.Types.Concrete.AnyType)
connectTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encrypt: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
failoverPartner: any(Azure.Bicep.Types.Concrete.AnyType)
hostNameInCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
integratedSecurity: any(Azure.Bicep.Types.Concrete.AnyType)
loadBalanceTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
maxPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
minPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
multipleActiveResultSets: any(Azure.Bicep.Types.Concrete.AnyType)
multiSubnetFailover: any(Azure.Bicep.Types.Concrete.AnyType)
packetSize: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureStorage, use:
{
type: 'AzureStorage'
typeProperties: {
accountKey: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
sasToken: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
sasUri: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSynapseArtifacts, use:
{
type: 'AzureSynapseArtifacts'
typeProperties: {
authentication: any(Azure.Bicep.Types.Concrete.AnyType)
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
workspaceResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureTableStorage, use:
{
type: 'AzureTableStorage'
typeProperties: {
accountKey: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
encryptedCredential: 'string'
sasToken: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
sasUri: any(Azure.Bicep.Types.Concrete.AnyType)
serviceEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Cassandra, use:
{
type: 'Cassandra'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CommonDataServiceForApps, use:
{
type: 'CommonDataServiceForApps'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
deploymentType: any(Azure.Bicep.Types.Concrete.AnyType)
domain: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
hostName: any(Azure.Bicep.Types.Concrete.AnyType)
organizationName: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
serviceUri: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Concur, use:
{
type: 'Concur'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CosmosDb, use:
{
type: 'CosmosDb'
typeProperties: {
accountEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
accountKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
connectionMode: 'string'
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CosmosDbMongoDbApi, use:
{
type: 'CosmosDbMongoDbApi'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
isServerVersionAbove32: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Couchbase, use:
{
type: 'Couchbase'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credString: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
encryptedCredential: 'string'
}
}
For CustomDataSource, use:
{
type: 'CustomDataSource'
typeProperties: any(Azure.Bicep.Types.Concrete.AnyType)
}
For Dataworld, use:
{
type: 'Dataworld'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
}
}
For Db2, use:
{
type: 'Db2'
typeProperties: {
authenticationType: 'string'
certificateCommonName: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
packageCollection: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Drill, use:
{
type: 'Drill'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
pwd: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For Dynamics, use:
{
type: 'Dynamics'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
deploymentType: any(Azure.Bicep.Types.Concrete.AnyType)
domain: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
hostName: any(Azure.Bicep.Types.Concrete.AnyType)
organizationName: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
serviceUri: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DynamicsAX, use:
{
type: 'DynamicsAX'
typeProperties: {
aadResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
url: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DynamicsCrm, use:
{
type: 'DynamicsCrm'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
deploymentType: any(Azure.Bicep.Types.Concrete.AnyType)
domain: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
hostName: any(Azure.Bicep.Types.Concrete.AnyType)
organizationName: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
serviceUri: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Eloqua, use:
{
type: 'Eloqua'
typeProperties: {
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For FileServer, use:
{
type: 'FileServer'
typeProperties: {
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For FtpServer, use:
{
type: 'FtpServer'
typeProperties: {
authenticationType: 'string'
enableServerCertificateValidation: any(Azure.Bicep.Types.Concrete.AnyType)
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleAdWords, use:
{
type: 'GoogleAdWords'
typeProperties: {
authenticationType: 'string'
clientCustomerID: any(Azure.Bicep.Types.Concrete.AnyType)
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
developerToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
email: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
googleAdsApiVersion: any(Azure.Bicep.Types.Concrete.AnyType)
keyFilePath: any(Azure.Bicep.Types.Concrete.AnyType)
loginCustomerID: any(Azure.Bicep.Types.Concrete.AnyType)
privateKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
refreshToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
supportLegacyDataTypes: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleBigQuery, use:
{
type: 'GoogleBigQuery'
typeProperties: {
additionalProjects: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
email: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
keyFilePath: any(Azure.Bicep.Types.Concrete.AnyType)
project: any(Azure.Bicep.Types.Concrete.AnyType)
refreshToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
requestGoogleDriveScope: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleBigQueryV2, use:
{
type: 'GoogleBigQueryV2'
typeProperties: {
authenticationType: 'string'
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
keyFileContent: {
type: 'string'
// For remaining properties, see SecretBase objects
}
projectId: any(Azure.Bicep.Types.Concrete.AnyType)
refreshToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
For GoogleCloudStorage, use:
{
type: 'GoogleCloudStorage'
typeProperties: {
accessKeyId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
secretAccessKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
serviceUrl: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleSheets, use:
{
type: 'GoogleSheets'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
}
}
For Greenplum, use:
{
type: 'Greenplum'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
pwd: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For HBase, use:
{
type: 'HBase'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
httpPath: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HDInsight, use:
{
type: 'HDInsight'
typeProperties: {
clusterUri: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
fileSystem: any(Azure.Bicep.Types.Concrete.AnyType)
hcatalogLinkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
isEspEnabled: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HDInsightOnDemand, use:
{
type: 'HDInsightOnDemand'
typeProperties: {
additionalLinkedServiceNames: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
clusterNamePrefix: any(Azure.Bicep.Types.Concrete.AnyType)
clusterPassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
clusterResourceGroup: any(Azure.Bicep.Types.Concrete.AnyType)
clusterSize: any(Azure.Bicep.Types.Concrete.AnyType)
clusterSshPassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
clusterSshUserName: any(Azure.Bicep.Types.Concrete.AnyType)
clusterType: any(Azure.Bicep.Types.Concrete.AnyType)
clusterUserName: any(Azure.Bicep.Types.Concrete.AnyType)
coreConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
dataNodeSize: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
hBaseConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
hcatalogLinkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
hdfsConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
headNodeSize: any(Azure.Bicep.Types.Concrete.AnyType)
hiveConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
hostSubscriptionId: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
mapReduceConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
oozieConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
scriptActions: [
{
name: 'string'
parameters: 'string'
roles: any(Azure.Bicep.Types.Concrete.AnyType)
uri: 'string'
}
]
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
sparkVersion: any(Azure.Bicep.Types.Concrete.AnyType)
stormConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
subnetName: any(Azure.Bicep.Types.Concrete.AnyType)
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
timeToLive: any(Azure.Bicep.Types.Concrete.AnyType)
version: any(Azure.Bicep.Types.Concrete.AnyType)
virtualNetworkId: any(Azure.Bicep.Types.Concrete.AnyType)
yarnConfiguration: any(Azure.Bicep.Types.Concrete.AnyType)
zookeeperNodeSize: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Hdfs, use:
{
type: 'Hdfs'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Hive, use:
{
type: 'Hive'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
httpPath: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
serverType: 'string'
serviceDiscoveryMode: any(Azure.Bicep.Types.Concrete.AnyType)
thriftTransportProtocol: 'string'
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
useNativeQuery: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
zooKeeperNameSpace: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HttpServer, use:
{
type: 'HttpServer'
typeProperties: {
authenticationType: 'string'
authHeaders: any(Azure.Bicep.Types.Concrete.AnyType)
certThumbprint: any(Azure.Bicep.Types.Concrete.AnyType)
embeddedCertData: any(Azure.Bicep.Types.Concrete.AnyType)
enableServerCertificateValidation: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Hubspot, use:
{
type: 'Hubspot'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
refreshToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Impala, use:
{
type: 'Impala'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Informix, use:
{
type: 'Informix'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Jira, use:
{
type: 'Jira'
typeProperties: {
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For LakeHouse, use:
{
type: 'LakeHouse'
typeProperties: {
artifactId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
workspaceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Magento, use:
{
type: 'Magento'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MariaDB, use:
{
type: 'MariaDB'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
driverVersion: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
sslMode: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Marketo, use:
{
type: 'Marketo'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MicrosoftAccess, use:
{
type: 'MicrosoftAccess'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDb, use:
{
type: 'MongoDb'
typeProperties: {
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
authSource: any(Azure.Bicep.Types.Concrete.AnyType)
databaseName: any(Azure.Bicep.Types.Concrete.AnyType)
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDbAtlas, use:
{
type: 'MongoDbAtlas'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
driverVersion: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDbV2, use:
{
type: 'MongoDbV2'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MySql, use:
{
type: 'MySql'
typeProperties: {
allowZeroDateTime: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectionTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
convertZeroDateTime: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
driverVersion: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
guidFormat: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
sslCert: any(Azure.Bicep.Types.Concrete.AnyType)
sslKey: any(Azure.Bicep.Types.Concrete.AnyType)
sslMode: any(Azure.Bicep.Types.Concrete.AnyType)
treatTinyAsBoolean: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Netezza, use:
{
type: 'Netezza'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
pwd: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For OData, use:
{
type: 'OData'
typeProperties: {
aadResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
aadServicePrincipalCredentialType: 'string'
authenticationType: 'string'
authHeaders: any(Azure.Bicep.Types.Concrete.AnyType)
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCert: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Odbc, use:
{
type: 'Odbc'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Office365, use:
{
type: 'Office365'
typeProperties: {
encryptedCredential: 'string'
office365TenantId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalTenantId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Oracle, use:
{
type: 'Oracle'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For OracleCloudStorage, use:
{
type: 'OracleCloudStorage'
typeProperties: {
accessKeyId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
secretAccessKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
serviceUrl: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For OracleServiceCloud, use:
{
type: 'OracleServiceCloud'
typeProperties: {
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Paypal, use:
{
type: 'Paypal'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Phoenix, use:
{
type: 'Phoenix'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
httpPath: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For PostgreSql, use:
{
type: 'PostgreSql'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For PostgreSqlV2, use:
{
type: 'PostgreSqlV2'
typeProperties: {
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
encoding: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
logParameters: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
port: any(Azure.Bicep.Types.Concrete.AnyType)
readBufferSize: any(Azure.Bicep.Types.Concrete.AnyType)
schema: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
sslCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
sslKey: any(Azure.Bicep.Types.Concrete.AnyType)
sslMode: any(Azure.Bicep.Types.Concrete.AnyType)
sslPassword: any(Azure.Bicep.Types.Concrete.AnyType)
timezone: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Presto, use:
{
type: 'Presto'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
catalog: any(Azure.Bicep.Types.Concrete.AnyType)
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
serverVersion: any(Azure.Bicep.Types.Concrete.AnyType)
timeZoneID: any(Azure.Bicep.Types.Concrete.AnyType)
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For QuickBooks, use:
{
type: 'QuickBooks'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
accessTokenSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
companyId: any(Azure.Bicep.Types.Concrete.AnyType)
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
consumerKey: any(Azure.Bicep.Types.Concrete.AnyType)
consumerSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Quickbase, use:
{
type: 'Quickbase'
typeProperties: {
encryptedCredential: 'string'
url: any(Azure.Bicep.Types.Concrete.AnyType)
userToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
For Responsys, use:
{
type: 'Responsys'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For RestService, use:
{
type: 'RestService'
typeProperties: {
aadResourceId: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
authHeaders: any(Azure.Bicep.Types.Concrete.AnyType)
azureCloudType: any(Azure.Bicep.Types.Concrete.AnyType)
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
credential: {
referenceName: 'string'
type: 'string'
}
enableServerCertificateValidation: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
resource: any(Azure.Bicep.Types.Concrete.AnyType)
scope: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalEmbeddedCert: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
tokenEndpoint: any(Azure.Bicep.Types.Concrete.AnyType)
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Salesforce, use:
{
type: 'Salesforce'
typeProperties: {
apiVersion: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
environmentUrl: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
securityToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceMarketingCloud, use:
{
type: 'SalesforceMarketingCloud'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceServiceCloud, use:
{
type: 'SalesforceServiceCloud'
typeProperties: {
apiVersion: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
environmentUrl: any(Azure.Bicep.Types.Concrete.AnyType)
extendedProperties: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
securityToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceServiceCloudV2, use:
{
type: 'SalesforceServiceCloudV2'
typeProperties: {
apiVersion: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
environmentUrl: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceV2, use:
{
type: 'SalesforceV2'
typeProperties: {
apiVersion: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: any(Azure.Bicep.Types.Concrete.AnyType)
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
environmentUrl: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapBW, use:
{
type: 'SapBW'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
systemNumber: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapCloudForCustomer, use:
{
type: 'SapCloudForCustomer'
typeProperties: {
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapEcc, use:
{
type: 'SapEcc'
typeProperties: {
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapHana, use:
{
type: 'SapHana'
typeProperties: {
authenticationType: 'string'
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapOdp, use:
{
type: 'SapOdp'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
language: any(Azure.Bicep.Types.Concrete.AnyType)
logonGroup: any(Azure.Bicep.Types.Concrete.AnyType)
messageServer: any(Azure.Bicep.Types.Concrete.AnyType)
messageServerService: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
sncLibraryPath: any(Azure.Bicep.Types.Concrete.AnyType)
sncMode: any(Azure.Bicep.Types.Concrete.AnyType)
sncMyName: any(Azure.Bicep.Types.Concrete.AnyType)
sncPartnerName: any(Azure.Bicep.Types.Concrete.AnyType)
sncQop: any(Azure.Bicep.Types.Concrete.AnyType)
subscriberName: any(Azure.Bicep.Types.Concrete.AnyType)
systemId: any(Azure.Bicep.Types.Concrete.AnyType)
systemNumber: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
x509CertificatePath: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapOpenHub, use:
{
type: 'SapOpenHub'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
language: any(Azure.Bicep.Types.Concrete.AnyType)
logonGroup: any(Azure.Bicep.Types.Concrete.AnyType)
messageServer: any(Azure.Bicep.Types.Concrete.AnyType)
messageServerService: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
systemId: any(Azure.Bicep.Types.Concrete.AnyType)
systemNumber: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapTable, use:
{
type: 'SapTable'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
language: any(Azure.Bicep.Types.Concrete.AnyType)
logonGroup: any(Azure.Bicep.Types.Concrete.AnyType)
messageServer: any(Azure.Bicep.Types.Concrete.AnyType)
messageServerService: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
sncLibraryPath: any(Azure.Bicep.Types.Concrete.AnyType)
sncMode: any(Azure.Bicep.Types.Concrete.AnyType)
sncMyName: any(Azure.Bicep.Types.Concrete.AnyType)
sncPartnerName: any(Azure.Bicep.Types.Concrete.AnyType)
sncQop: any(Azure.Bicep.Types.Concrete.AnyType)
systemId: any(Azure.Bicep.Types.Concrete.AnyType)
systemNumber: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ServiceNow, use:
{
type: 'ServiceNow'
typeProperties: {
authenticationType: 'string'
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ServiceNowV2, use:
{
type: 'ServiceNowV2'
typeProperties: {
authenticationType: 'string'
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
grantType: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Sftp, use:
{
type: 'Sftp'
typeProperties: {
authenticationType: 'string'
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
hostKeyFingerprint: any(Azure.Bicep.Types.Concrete.AnyType)
passPhrase: {
type: 'string'
// For remaining properties, see SecretBase objects
}
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
privateKeyContent: {
type: 'string'
// For remaining properties, see SecretBase objects
}
privateKeyPath: any(Azure.Bicep.Types.Concrete.AnyType)
skipHostKeyValidation: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SharePointOnlineList, use:
{
type: 'SharePointOnlineList'
typeProperties: {
encryptedCredential: 'string'
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalEmbeddedCert: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
siteUrl: any(Azure.Bicep.Types.Concrete.AnyType)
tenantId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Shopify, use:
{
type: 'Shopify'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Smartsheet, use:
{
type: 'Smartsheet'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
}
}
For Snowflake, use:
{
type: 'Snowflake'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
}
}
For SnowflakeV2, use:
{
type: 'SnowflakeV2'
typeProperties: {
accountIdentifier: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
privateKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
privateKeyPassphrase: {
type: 'string'
// For remaining properties, see SecretBase objects
}
scope: any(Azure.Bicep.Types.Concrete.AnyType)
tenantId: any(Azure.Bicep.Types.Concrete.AnyType)
user: any(Azure.Bicep.Types.Concrete.AnyType)
warehouse: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Spark, use:
{
type: 'Spark'
typeProperties: {
allowHostNameCNMismatch: any(Azure.Bicep.Types.Concrete.AnyType)
allowSelfSignedServerCert: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
enableSsl: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
httpPath: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
port: any(Azure.Bicep.Types.Concrete.AnyType)
serverType: 'string'
thriftTransportProtocol: 'string'
trustedCertPath: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
useSystemTrustStore: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SqlServer, use:
{
type: 'SqlServer'
typeProperties: {
alwaysEncryptedSettings: {
alwaysEncryptedAkvAuthType: 'string'
credential: {
referenceName: 'string'
type: 'string'
}
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
applicationIntent: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
commandTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
connectRetryInterval: any(Azure.Bicep.Types.Concrete.AnyType)
connectTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
credential: {
referenceName: 'string'
type: 'string'
}
database: any(Azure.Bicep.Types.Concrete.AnyType)
encrypt: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
failoverPartner: any(Azure.Bicep.Types.Concrete.AnyType)
hostNameInCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
integratedSecurity: any(Azure.Bicep.Types.Concrete.AnyType)
loadBalanceTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
maxPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
minPoolSize: any(Azure.Bicep.Types.Concrete.AnyType)
multipleActiveResultSets: any(Azure.Bicep.Types.Concrete.AnyType)
multiSubnetFailover: any(Azure.Bicep.Types.Concrete.AnyType)
packetSize: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
pooling: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
trustServerCertificate: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Square, use:
{
type: 'Square'
typeProperties: {
clientId: any(Azure.Bicep.Types.Concrete.AnyType)
clientSecret: {
type: 'string'
// For remaining properties, see SecretBase objects
}
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
redirectUri: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Sybase, use:
{
type: 'Sybase'
typeProperties: {
authenticationType: 'string'
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
server: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For TeamDesk, use:
{
type: 'TeamDesk'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
authenticationType: 'string'
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Teradata, use:
{
type: 'Teradata'
typeProperties: {
authenticationType: 'string'
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Twilio, use:
{
type: 'Twilio'
typeProperties: {
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Vertica, use:
{
type: 'Vertica'
typeProperties: {
connectionString: any(Azure.Bicep.Types.Concrete.AnyType)
database: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
port: any(Azure.Bicep.Types.Concrete.AnyType)
pwd: {
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'string'
}
server: any(Azure.Bicep.Types.Concrete.AnyType)
uid: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Warehouse, use:
{
type: 'Warehouse'
typeProperties: {
artifactId: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalCredential: {
type: 'string'
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalId: any(Azure.Bicep.Types.Concrete.AnyType)
servicePrincipalKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
tenant: any(Azure.Bicep.Types.Concrete.AnyType)
workspaceId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Web, use:
{
type: 'Web'
typeProperties: {
url: any(Azure.Bicep.Types.Concrete.AnyType)
authenticationType: 'string'
// For remaining properties, see WebLinkedServiceTypeProperties objects
}
}
For Xero, use:
{
type: 'Xero'
typeProperties: {
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
consumerKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
encryptedCredential: 'string'
host: any(Azure.Bicep.Types.Concrete.AnyType)
privateKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Zendesk, use:
{
type: 'Zendesk'
typeProperties: {
apiToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
authenticationType: 'string'
encryptedCredential: 'string'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
url: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Zoho, use:
{
type: 'Zoho'
typeProperties: {
accessToken: {
type: 'string'
// For remaining properties, see SecretBase objects
}
connectionProperties: any(Azure.Bicep.Types.Concrete.AnyType)
encryptedCredential: 'string'
endpoint: any(Azure.Bicep.Types.Concrete.AnyType)
useEncryptedEndpoints: any(Azure.Bicep.Types.Concrete.AnyType)
useHostVerification: any(Azure.Bicep.Types.Concrete.AnyType)
usePeerVerification: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
SecretBase objects
Set the type property to specify the type of object.
For AzureKeyVaultSecret, use:
{
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'AzureKeyVaultSecret'
}
For SecureString, use:
{
type: 'SecureString'
value: 'string'
}
WebLinkedServiceTypeProperties objects
Set the authenticationType property to specify the type of object.
For Anonymous, use:
{
authenticationType: 'Anonymous'
}
For Basic, use:
{
authenticationType: 'Basic'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
username: any(Azure.Bicep.Types.Concrete.AnyType)
}
For ClientCertificate, use:
{
authenticationType: 'ClientCertificate'
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
pfx: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
Property values
AmazonMWSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonMWS' (required) |
| typeProperties | Amazon Marketplace Web Service linked service properties. | AmazonMWSLinkedServiceTypeProperties (required) |
AmazonMWSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key id used to access data. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) | any (required) |
| marketplaceID | 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) | any (required) |
| mwsAuthToken | The Amazon MWS authentication token. | SecretBase |
| secretKey | The secret key used to access data. | SecretBase |
| sellerID | The Amazon seller ID. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
AmazonRdsForLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
AmazonRdsForOracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForOracle' (required) |
| typeProperties | AmazonRdsForOracle database linked service properties. | AmazonRdsForLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForSqlServer' (required) |
| typeProperties | Amazon RDS for SQL Server linked service properties. | AmazonRdsForSqlServerLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
AmazonRedshiftLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRedshift' (required) |
| typeProperties | Amazon Redshift linked service properties. | AmazonRedshiftLinkedServiceTypeProperties (required) |
AmazonRedshiftLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| database | The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Amazon Redshift source. | SecretBase |
| port | 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). | any |
| server | The name of the Amazon Redshift server. Type: string (or Expression with resultType string). | any (required) |
| username | The username of the Amazon Redshift source. Type: string (or Expression with resultType string). | any |
AmazonS3CompatibleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3Compatible' (required) |
| typeProperties | Amazon S3 Compatible linked service properties. | AmazonS3CompatibleLinkedServiceTypeProperties (required) |
AmazonS3CompatibleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| forcePathStyle | If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| secretAccessKey | The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
AmazonS3LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3' (required) |
| typeProperties | Amazon S3 linked service properties. | AmazonS3LinkedServiceTypeProperties (required) |
AmazonS3LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| authenticationType | The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Amazon S3 Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
| sessionToken | The session token for the S3 temporary security credential. | SecretBase |
AppFiguresLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AppFigures' (required) |
| typeProperties | AppFigures linked service properties. | AppFiguresLinkedServiceTypeProperties (required) |
AppFiguresLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientKey | The client key for the AppFigures source. | SecretBase (required) |
| password | The password of the AppFigures source. | SecretBase (required) |
| userName | The username of the Appfigures source. Type: string (or Expression with resultType string). | any (required) |
AsanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Asana' (required) |
| typeProperties | Asana linked service properties. | AsanaLinkedServiceTypeProperties (required) |
AsanaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Asana source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
AzureBatchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBatch' (required) |
| typeProperties | Azure Batch linked service properties. | AzureBatchLinkedServiceTypeProperties (required) |
AzureBatchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKey | The Azure Batch account access key. | SecretBase |
| accountName | The Azure Batch account name. Type: string (or Expression with resultType string). | any (required) |
| batchUri | The Azure Batch URI. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference (required) |
| poolName | The Azure Batch pool name. Type: string (or Expression with resultType string). | any (required) |
AzureBlobFSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobFS' (required) |
| typeProperties | Azure Data Lake Storage Gen2 linked service properties. | AzureBlobFSLinkedServiceTypeProperties (required) |
AzureBlobFSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | SecretBase |
| sasUri | SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| url | Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
AzureBlobStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobStorage' (required) |
| typeProperties | Azure Blob Storage linked service properties. | AzureBlobStorageLinkedServiceTypeProperties (required) |
AzureBlobStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| accountKind | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'AccountKey' 'Anonymous' 'Msi' 'SasUri' 'ServicePrincipal' |
| azureCloudType | 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). | any |
| connectionString | The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| containerUri | Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDatabricksDeltaLakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricksDeltaLake' (required) |
| typeProperties | Azure Databricks Delta Lake linked service properties. | AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required) |
AzureDatabricksDetltaLakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. | SecretBase |
| clusterId | The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricks' (required) |
| typeProperties | Azure Databricks linked service properties. | AzureDatabricksLinkedServiceTypeProperties (required) |
AzureDatabricksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string). | SecretBase |
| authentication | Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| existingClusterId | The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| instancePoolId | The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| newClusterCustomTags | Additional tags for cluster resources. This property is ignored in instance pool configurations. | AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags |
| newClusterDriverNodeType | The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string). | any |
| newClusterEnableElasticDisk | 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). | any |
| newClusterInitScripts | User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings). | any |
| newClusterLogDestination | Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string). | any |
| newClusterNodeType | 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). | any |
| newClusterNumOfWorker | 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). | any |
| newClusterSparkConf | A set of optional, user-specified Spark configuration key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf |
| newClusterSparkEnvVars | A set of optional, user-specified Spark environment variables key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars |
| newClusterVersion | 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). | any |
| policyId | 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). | any |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars
| Name | Description | Value |
|---|
AzureDataExplorerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataExplorer' (required) |
| typeProperties | Azure Data Explorer (Kusto) linked service properties. | AzureDataExplorerLinkedServiceTypeProperties (required) |
AzureDataExplorerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| credential | The credential reference containing authentication information. | CredentialReference |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| endpoint | The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://<clusterName>.<regionName>.kusto.windows.net. Type: string (or Expression with resultType string) | any (required) |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Kusto. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDataLakeAnalyticsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeAnalytics' (required) |
| typeProperties | Azure Data Lake Analytics linked service properties. | AzureDataLakeAnalyticsLinkedServiceTypeProperties (required) |
AzureDataLakeAnalyticsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string). | any (required) |
| dataLakeAnalyticsUri | Azure Data Lake Analytics URI Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Analytics account. | SecretBase |
| subscriptionId | Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
AzureDataLakeStoreLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeStore' (required) |
| typeProperties | Azure Data Lake Store linked service properties. | AzureDataLakeStoreLinkedServiceTypeProperties (required) |
AzureDataLakeStoreLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | Data Lake Store account name. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataLakeStoreUri | Data Lake Store service URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Store account. | SecretBase |
| subscriptionId | Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureFileStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFileStorage' (required) |
| typeProperties | Azure File Storage linked service properties. | AzureFileStorageLinkedServiceTypeProperties (required) |
AzureFileStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileShare | The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string). | any |
| host | Host name of the server. Type: string (or Expression with resultType string). | any |
| password | Password to logon the server. | SecretBase |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| snapshot | The azure file share snapshot version. Type: string (or Expression with resultType string). | any |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
AzureFunctionLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFunction' (required) |
| typeProperties | Azure Function linked service properties. | AzureFunctionLinkedServiceTypeProperties (required) |
AzureFunctionLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| functionAppUrl | The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string). | any (required) |
| functionKey | Function or Host key for Azure Function App. | SecretBase |
| resourceId | Allowed token audiences for azure function. Type: string (or Expression with resultType string). | any |
AzureKeyVaultLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureKeyVault' (required) |
| typeProperties | Azure Key Vault linked service properties. | AzureKeyVaultLinkedServiceTypeProperties (required) |
AzureKeyVaultLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| baseUrl | The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | string (required) |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | 'AzureKeyVaultSecret' (required) |
AzureMariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMariaDB' (required) |
| typeProperties | Azure Database for MariaDB linked service properties. | AzureMariaDBLinkedServiceTypeProperties (required) |
AzureMariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzureMLLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureML' (required) |
| typeProperties | Azure ML Studio Web Service linked service properties. | AzureMLLinkedServiceTypeProperties (required) |
AzureMLLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The API key for accessing the Azure ML model endpoint. | SecretBase (required) |
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlEndpoint | The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| updateResourceEndpoint | The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any |
AzureMLServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMLService' (required) |
| typeProperties | Azure ML Service linked service properties. | AzureMLServiceLinkedServiceTypeProperties (required) |
AzureMLServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlWorkspaceName | Azure ML Service workspace name. Type: string (or Expression with resultType string). | any (required) |
| resourceGroupName | Azure ML Service workspace resource group name. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. | SecretBase |
| subscriptionId | Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string). | any (required) |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureMySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMySql' (required) |
| typeProperties | Azure MySQL database linked service properties. | AzureMySqlLinkedServiceTypeProperties (required) |
AzureMySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzurePostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzurePostgreSql' (required) |
| typeProperties | Azure PostgreSQL linked service properties. | AzurePostgreSqlLinkedServiceTypeProperties (required) |
AzurePostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| commandTimeout | 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. | any |
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any |
| timeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any |
AzureSearchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSearch' (required) |
| typeProperties | Windows Azure Search Service linked service properties. | AzureSearchLinkedServiceTypeProperties (required) |
AzureSearchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| key | Admin Key for Azure Search service | SecretBase |
| url | URL for Azure Search service. Type: string (or Expression with resultType string). | any (required) |
AzureSqlDatabaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDatabase' (required) |
| typeProperties | Azure SQL Database linked service properties. | AzureSqlDatabaseLinkedServiceTypeProperties (required) |
AzureSqlDatabaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Database. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlDWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDW' (required) |
| typeProperties | Azure SQL Data Warehouse linked service properties. | AzureSqlDWLinkedServiceTypeProperties (required) |
AzureSqlDWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlMILinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlMI' (required) |
| typeProperties | Azure SQL Managed Instance linked service properties. | AzureSqlMILinkedServiceTypeProperties (required) |
AzureSqlMILinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Managed Instance. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureStorage' (required) |
| typeProperties | Azure Storage linked service properties. | AzureStorageLinkedServiceTypeProperties (required) |
AzureStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
AzureSynapseArtifactsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSynapseArtifacts' (required) |
| typeProperties | Azure Synapse Analytics (Artifacts) linked service properties. | AzureSynapseArtifactsLinkedServiceTypeProperties (required) |
AzureSynapseArtifactsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string). | any |
| endpoint | https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string). | any (required) |
| workspaceResourceId | 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). | any |
AzureTableStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureTableStorage' (required) |
| typeProperties | Azure Table Storage linked service properties. | AzureTableStorageLinkedServiceTypeProperties (required) |
AzureTableStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
CassandraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Cassandra' (required) |
| typeProperties | Cassandra linked service properties. | CassandraLinkedServiceTypeProperties (required) |
CassandraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name for connection. Type: string (or Expression with resultType string). | any (required) |
| password | Password for authentication. | SecretBase |
| port | The port for the connection. Type: integer (or Expression with resultType integer). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
CommonDataServiceForAppsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CommonDataServiceForApps' (required) |
| typeProperties | Common Data Service for Apps linked service properties. | CommonDataServiceForAppsLinkedServiceTypeProperties (required) |
CommonDataServiceForAppsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Common Data Service for Apps instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). | any |
ConcurLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Concur' (required) |
| typeProperties | Concur Service linked service properties. | ConcurLinkedServiceTypeProperties (required) |
ConcurLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | Application client_id supplied by Concur App Management. | any (required) |
| connectionProperties | Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Concur Service. | any (required) |
CosmosDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDb' (required) |
| typeProperties | CosmosDB linked service properties. | CosmosDbLinkedServiceTypeProperties (required) |
CosmosDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountEndpoint | The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) | any |
| accountKey | The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. | SecretBase |
| azureCloudType | 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). | any |
| connectionMode | The connection mode used to access CosmosDB account. Type: string. | 'Direct' 'Gateway' |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database. Type: string (or Expression with resultType string) | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
CosmosDbMongoDbApiLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDbMongoDbApi' (required) |
| typeProperties | CosmosDB (MongoDB API) linked service properties. | CosmosDbMongoDbApiLinkedServiceTypeProperties (required) |
CosmosDbMongoDbApiLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| isServerVersionAbove32 | Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
CouchbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Couchbase' (required) |
| typeProperties | Couchbase server linked service properties. | CouchbaseLinkedServiceTypeProperties (required) |
CouchbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credString | The Azure key vault secret reference of credString in connection string. | AzureKeyVaultSecretReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
CredentialReference
| Name | Description | Value |
|---|---|---|
| referenceName | Reference credential name. | string (required) |
| type | Credential reference type. | 'CredentialReference' (required) |
CustomDataSourceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CustomDataSource' (required) |
| typeProperties | Custom linked service properties. | any (required) |
DataworldLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dataworld' (required) |
| typeProperties | Dataworld linked service properties. | DataworldLinkedServiceTypeProperties (required) |
DataworldLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Dataworld source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
Db2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Db2' (required) |
| typeProperties | DB2 linked service properties. | Db2LinkedServiceTypeProperties (required) |
Db2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. | 'Basic' |
| certificateCommonName | Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| connectionString | The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. | string |
| packageCollection | Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
DrillLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Drill' (required) |
| typeProperties | Drill server linked service properties. | DrillLinkedServiceTypeProperties (required) |
DrillLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
DynamicsAXLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsAX' (required) |
| typeProperties | Dynamics AX linked service properties. | DynamicsAXLinkedServiceTypeProperties (required) |
DynamicsAXLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | 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). | SecretBase (required) |
| tenant | 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). | any (required) |
| url | The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint. | any (required) |
DynamicsCrmLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsCrm' (required) |
| typeProperties | Dynamics CRM linked service properties. | DynamicsCrmLinkedServiceTypeProperties (required) |
DynamicsCrmLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics CRM instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string). | any |
DynamicsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dynamics' (required) |
| typeProperties | Dynamics linked service properties. | DynamicsLinkedServiceTypeProperties (required) |
DynamicsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics instance. Type: string (or Expression with resultType string). | any |
EloquaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Eloqua' (required) |
| typeProperties | Eloqua server linked service properties. | EloquaLinkedServiceTypeProperties (required) |
EloquaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Eloqua server. (i.e. eloqua.example.com) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice) | any (required) |
FileServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FileServer' (required) |
| typeProperties | File system linked service properties. | FileServerLinkedServiceTypeProperties (required) |
FileServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the server. | SecretBase |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
FtpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FtpServer' (required) |
| typeProperties | Properties specific to this linked service type. | FtpServerLinkedServiceTypeProperties (required) |
FtpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Anonymous' 'Basic' |
| enableServerCertificateValidation | 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). | any |
| enableSsl | If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the FTP server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the FTP server. | SecretBase |
| port | 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. | any |
| userName | Username to logon the FTP server. Type: string (or Expression with resultType string). | any |
GoogleAdWordsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleAdWords' (required) |
| typeProperties | Google AdWords service linked service properties. | GoogleAdWordsLinkedServiceTypeProperties (required) |
GoogleAdWordsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' |
| clientCustomerID | The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). | any |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| connectionProperties | (Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| developerToken | The developer token associated with the manager account that you use to grant access to the AdWords API. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| googleAdsApiVersion | 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). | any |
| keyFilePath | (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). | any |
| loginCustomerID | 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). | any |
| privateKey | The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. | SecretBase |
| refreshToken | The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. | SecretBase |
| supportLegacyDataTypes | 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). | any |
| trustedCertPath | (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). | any |
| useSystemTrustStore | (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). | any |
GoogleBigQueryLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQuery' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryLinkedServiceTypeProperties (required) |
GoogleBigQueryLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalProjects | A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string). | any |
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFilePath | 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). | any |
| project | The default BigQuery project to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
| requestGoogleDriveScope | 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). | any |
| trustedCertPath | 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). | any |
| useSystemTrustStore | 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). | any |
GoogleBigQueryV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQueryV2' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryV2LinkedServiceTypeProperties (required) |
GoogleBigQueryV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFileContent | The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). | SecretBase |
| projectId | The default BigQuery project id to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
GoogleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleCloudStorage' (required) |
| typeProperties | Google Cloud Storage linked service properties. | GoogleCloudStorageLinkedServiceTypeProperties (required) |
GoogleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
GoogleSheetsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleSheets' (required) |
| typeProperties | GoogleSheets linked service properties. | GoogleSheetsLinkedServiceTypeProperties (required) |
GoogleSheetsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the GoogleSheets source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
GreenplumLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Greenplum' (required) |
| typeProperties | Greenplum Database linked service properties. | GreenplumLinkedServiceTypeProperties (required) |
GreenplumLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
HBaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HBase' (required) |
| typeProperties | HBase server linked service properties. | HBaseLinkedServiceTypeProperties (required) |
HBaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism to use to connect to the HBase server. | 'Anonymous' 'Basic' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the HBase server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the HBase instance uses to listen for client connections. The default value is 9090. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the HBase instance. | any |
HdfsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hdfs' (required) |
| typeProperties | HDFS linked service properties. | HdfsLinkedServiceTypeProperties (required) |
HdfsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Windows authentication. | SecretBase |
| url | The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Windows authentication. Type: string (or Expression with resultType string). | any |
HDInsightLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsight' (required) |
| typeProperties | HDInsight linked service properties. | HDInsightLinkedServiceTypeProperties (required) |
HDInsightLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clusterUri | HDInsight cluster URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileSystem | Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string). | any |
| hcatalogLinkedServiceName | A reference to the Azure SQL linked service that points to the HCatalog database. | LinkedServiceReference |
| isEspEnabled | Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean. | any |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference |
| password | HDInsight cluster password. | SecretBase |
| userName | HDInsight cluster user name. Type: string (or Expression with resultType string). | any |
HDInsightOnDemandLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsightOnDemand' (required) |
| typeProperties | HDInsight ondemand linked service properties. | HDInsightOnDemandLinkedServiceTypeProperties (required) |
HDInsightOnDemandLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalLinkedServiceNames | Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. | LinkedServiceReference[] |
| clusterNamePrefix | The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). | any |
| clusterPassword | The password to access the cluster. | SecretBase |
| clusterResourceGroup | The resource group where the cluster belongs. Type: string (or Expression with resultType string). | any (required) |
| clusterSize | Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). | any (required) |
| clusterSshPassword | The password to SSH remotely connect cluster’s node (for Linux). | SecretBase |
| clusterSshUserName | The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string). | any |
| clusterType | The cluster type. Type: string (or Expression with resultType string). | any |
| clusterUserName | The username to access the cluster. Type: string (or Expression with resultType string). | any |
| coreConfiguration | Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataNodeSize | Specifies the size of the data node for the HDInsight cluster. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hBaseConfiguration | Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. | any |
| hcatalogLinkedServiceName | 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. | LinkedServiceReference |
| hdfsConfiguration | Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. | any |
| headNodeSize | Specifies the size of the head node for the HDInsight cluster. | any |
| hiveConfiguration | Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. | any |
| hostSubscriptionId | The customer’s subscription to host the cluster. Type: string (or Expression with resultType string). | any (required) |
| linkedServiceName | Azure Storage linked service to be used by the on-demand cluster for storing and processing data. | LinkedServiceReference (required) |
| mapReduceConfiguration | Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. | any |
| oozieConfiguration | Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. | any |
| scriptActions | Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /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. | ScriptAction[] |
| servicePrincipalId | The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key for the service principal id. | SecretBase |
| sparkVersion | The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). | any |
| stormConfiguration | Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. | any |
| subnetName | 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). | any |
| tenant | The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
| timeToLive | 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). | any (required) |
| version | Version of the HDInsight cluster. Type: string (or Expression with resultType string). | any (required) |
| virtualNetworkId | The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string). | any |
| yarnConfiguration | Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. | any |
| zookeeperNodeSize | Specifies the size of the Zoo Keeper node for the HDInsight cluster. | any |
HiveLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hive' (required) |
| typeProperties | Hive Server linked service properties. | HiveLinkedServiceTypeProperties (required) |
HiveLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Hive server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). | any (required) |
| httpPath | The partial URL corresponding to the Hive server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Hive server uses to listen for client connections. | any |
| serverType | The type of Hive server. | 'HiveServer1' 'HiveServer2' 'HiveThriftServer' |
| serviceDiscoveryMode | true to indicate using the ZooKeeper service, false not. | any |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| useNativeQuery | Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL. | any |
| username | The user name that you use to access Hive Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
| zooKeeperNameSpace | The namespace on ZooKeeper under which Hive Server 2 nodes are added. | any |
HttpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HttpServer' (required) |
| typeProperties | Properties specific to this linked service type. | HttpLinkedServiceTypeProperties (required) |
HttpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the HTTP server. | 'Anonymous' 'Basic' 'ClientCertificate' 'Digest' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| certThumbprint | 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). | any |
| embeddedCertData | 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). | any |
| enableServerCertificateValidation | If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. | SecretBase |
| url | The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string). | any |
HubspotLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hubspot' (required) |
| typeProperties | Hubspot Service linked service properties. | HubspotLinkedServiceTypeProperties (required) |
HubspotLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token obtained when initially authenticating your OAuth integration. | SecretBase |
| clientId | The client ID associated with your Hubspot application. | any (required) |
| clientSecret | The client secret associated with your Hubspot application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| refreshToken | The refresh token obtained when initially authenticating your OAuth integration. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ImpalaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Impala' (required) |
| typeProperties | Impala server linked service properties. | ImpalaLinkedServiceTypeProperties (required) |
ImpalaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication type to use. | 'Anonymous' 'SASLUsername' 'UsernameAndPassword' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Impala server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name when using UsernameAndPassword. | SecretBase |
| port | The TCP port that the Impala server uses to listen for client connections. The default value is 21050. | any |
| trustedCertPath | 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. | any |
| username | The user name used to access the Impala server. The default value is anonymous when using SASLUsername. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
InformixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Informix' (required) |
| typeProperties | Informix linked service properties. | InformixLinkedServiceTypeProperties (required) |
InformixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
IntegrationRuntimeReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for integration runtime. | ParameterValueSpecification |
| referenceName | Reference integration runtime name. | string (required) |
| type | Type of integration runtime. | 'IntegrationRuntimeReference' (required) |
JiraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Jira' (required) |
| typeProperties | Jira Service linked service properties. | JiraLinkedServiceTypeProperties (required) |
JiraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Jira service. (e.g. jira.example.com) | any (required) |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| port | 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. | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Jira Service. | any (required) |
LakeHouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'LakeHouse' (required) |
| typeProperties | Microsoft Fabric LakeHouse linked service properties. | LakeHouseLinkedServiceTypeProperties (required) |
LakeHouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric LakeHouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
LinkedService
| Name | Description | Value |
|---|---|---|
| annotations | List of tags that can be used for describing the linked service. | any[] |
| connectVia | The integration runtime reference. | IntegrationRuntimeReference |
| description | Linked service description. | string |
| parameters | Parameters for linked service. | ParameterDefinitionSpecification |
| type | Set to 'AmazonMWS' for type AmazonMWSLinkedService. Set to 'AmazonRdsForOracle' for type AmazonRdsForOracleLinkedService. Set to 'AmazonRdsForSqlServer' for type AmazonRdsForSqlServerLinkedService. Set to 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AmazonS3Compatible' for type AmazonS3CompatibleLinkedService. Set to 'AppFigures' for type AppFiguresLinkedService. Set to 'Asana' for type AsanaLinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureBlobFS' for type AzureBlobFSLinkedService. Set to 'AzureBlobStorage' for type AzureBlobStorageLinkedService. Set to 'AzureDataExplorer' for type AzureDataExplorerLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureDatabricksDeltaLake' for type AzureDatabricksDeltaLakeLinkedService. Set to 'AzureFileStorage' for type AzureFileStorageLinkedService. Set to 'AzureFunction' for type AzureFunctionLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. Set to 'AzureMLService' for type AzureMLServiceLinkedService. Set to 'AzureMariaDB' for type AzureMariaDBLinkedService. Set to 'AzureMySql' for type AzureMySqlLinkedService. Set to 'AzurePostgreSql' for type AzurePostgreSqlLinkedService. Set to 'AzureSearch' for type AzureSearchLinkedService. Set to 'AzureSqlDW' for type AzureSqlDWLinkedService. Set to 'AzureSqlDatabase' for type AzureSqlDatabaseLinkedService. Set to 'AzureSqlMI' for type AzureSqlMILinkedService. Set to 'AzureStorage' for type AzureStorageLinkedService. Set to 'AzureSynapseArtifacts' for type AzureSynapseArtifactsLinkedService. Set to 'AzureTableStorage' for type AzureTableStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'CommonDataServiceForApps' for type CommonDataServiceForAppsLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'CosmosDbMongoDbApi' for type CosmosDbMongoDbApiLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Dataworld' for type DataworldLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'DynamicsAX' for type DynamicsAXLinkedService. Set to 'DynamicsCrm' for type DynamicsCrmLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleAdWords' for type GoogleAdWordsLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. Set to 'GoogleBigQueryV2' for type GoogleBigQueryV2LinkedService. Set to 'GoogleCloudStorage' for type GoogleCloudStorageLinkedService. Set to 'GoogleSheets' for type GoogleSheetsLinkedService. Set to 'Greenplum' for type GreenplumLinkedService. Set to 'HBase' for type HBaseLinkedService. Set to 'HDInsight' for type HDInsightLinkedService. Set to 'HDInsightOnDemand' for type HDInsightOnDemandLinkedService. Set to 'Hdfs' for type HdfsLinkedService. Set to 'Hive' for type HiveLinkedService. Set to 'HttpServer' for type HttpLinkedService. Set to 'Hubspot' for type HubspotLinkedService. Set to 'Impala' for type ImpalaLinkedService. Set to 'Informix' for type InformixLinkedService. Set to 'Jira' for type JiraLinkedService. Set to 'LakeHouse' for type LakeHouseLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MicrosoftAccess' for type MicrosoftAccessLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. Set to 'MongoDbAtlas' for type MongoDbAtlasLinkedService. Set to 'MongoDbV2' for type MongoDbV2LinkedService. Set to 'MySql' for type MySqlLinkedService. Set to 'Netezza' for type NetezzaLinkedService. Set to 'OData' for type ODataLinkedService. Set to 'Odbc' for type OdbcLinkedService. Set to 'Office365' for type Office365LinkedService. Set to 'Oracle' for type OracleLinkedService. Set to 'OracleCloudStorage' for type OracleCloudStorageLinkedService. Set to 'OracleServiceCloud' for type OracleServiceCloudLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'PostgreSqlV2' for type PostgreSqlV2LinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Quickbase' for type QuickbaseLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'RestService' for type RestServiceLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. Set to 'SalesforceServiceCloud' for type SalesforceServiceCloudLinkedService. Set to 'SalesforceServiceCloudV2' for type SalesforceServiceCloudV2LinkedService. Set to 'SalesforceV2' for type SalesforceV2LinkedService. Set to 'SapBW' for type SapBWLinkedService. Set to 'SapCloudForCustomer' for type SapCloudForCustomerLinkedService. Set to 'SapEcc' for type SapEccLinkedService. Set to 'SapHana' for type SapHanaLinkedService. Set to 'SapOdp' for type SapOdpLinkedService. Set to 'SapOpenHub' for type SapOpenHubLinkedService. Set to 'SapTable' for type SapTableLinkedService. Set to 'ServiceNow' for type ServiceNowLinkedService. Set to 'ServiceNowV2' for type ServiceNowV2LinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'SharePointOnlineList' for type SharePointOnlineListLinkedService. Set to 'Shopify' for type ShopifyLinkedService. Set to 'Smartsheet' for type SmartsheetLinkedService. Set to 'Snowflake' for type SnowflakeLinkedService. Set to 'SnowflakeV2' for type SnowflakeV2LinkedService. Set to 'Spark' for type SparkLinkedService. Set to 'SqlServer' for type SqlServerLinkedService. Set to 'Square' for type SquareLinkedService. Set to 'Sybase' for type SybaseLinkedService. Set to 'TeamDesk' for type TeamDeskLinkedService. Set to 'Teradata' for type TeradataLinkedService. Set to 'Twilio' for type TwilioLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Warehouse' for type WarehouseLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zendesk' for type ZendeskLinkedService. Set to 'Zoho' for type ZohoLinkedService. | 'AmazonMWS' 'AmazonRdsForOracle' 'AmazonRdsForSqlServer' 'AmazonRedshift' 'AmazonS3' 'AmazonS3Compatible' 'AppFigures' 'Asana' 'AzureBatch' 'AzureBlobFS' 'AzureBlobStorage' 'AzureDatabricks' 'AzureDatabricksDeltaLake' 'AzureDataExplorer' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureFileStorage' 'AzureFunction' 'AzureKeyVault' 'AzureMariaDB' 'AzureML' 'AzureMLService' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureSqlMI' 'AzureStorage' 'AzureSynapseArtifacts' 'AzureTableStorage' 'Cassandra' 'CommonDataServiceForApps' 'Concur' 'CosmosDb' 'CosmosDbMongoDbApi' 'Couchbase' 'CustomDataSource' 'Dataworld' 'Db2' 'Drill' 'Dynamics' 'DynamicsAX' 'DynamicsCrm' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleAdWords' 'GoogleBigQuery' 'GoogleBigQueryV2' 'GoogleCloudStorage' 'GoogleSheets' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Informix' 'Jira' 'LakeHouse' 'Magento' 'MariaDB' 'Marketo' 'MicrosoftAccess' 'MongoDb' 'MongoDbAtlas' 'MongoDbV2' 'MySql' 'Netezza' 'OData' 'Odbc' 'Office365' 'Oracle' 'OracleCloudStorage' 'OracleServiceCloud' 'Paypal' 'Phoenix' 'PostgreSql' 'PostgreSqlV2' 'Presto' 'Quickbase' 'QuickBooks' 'Responsys' 'RestService' 'Salesforce' 'SalesforceMarketingCloud' 'SalesforceServiceCloud' 'SalesforceServiceCloudV2' 'SalesforceV2' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'SapOdp' 'SapOpenHub' 'SapTable' 'ServiceNow' 'ServiceNowV2' 'Sftp' 'SharePointOnlineList' 'Shopify' 'Smartsheet' 'Snowflake' 'SnowflakeV2' 'Spark' 'SqlServer' 'Square' 'Sybase' 'TeamDesk' 'Teradata' 'Twilio' 'Vertica' 'Warehouse' 'Web' 'Xero' 'Zendesk' 'Zoho' (required) |
| version | Version of the linked service. | string |
LinkedServiceReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for LinkedService. | ParameterValueSpecification |
| referenceName | Reference LinkedService name. | string (required) |
| type | Linked service reference type. | 'LinkedServiceReference' (required) |
MagentoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Magento' (required) |
| typeProperties | Magento server linked service properties. | MagentoLinkedServiceTypeProperties (required) |
MagentoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token from Magento. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Magento instance. (i.e. 192.168.222.110/magento3) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
MariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MariaDB' (required) |
| typeProperties | MariaDB server linked service properties. | MariaDBLinkedServiceTypeProperties (required) |
MariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default) | any |
MarketoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Marketo' (required) |
| typeProperties | Marketo server linked service properties. | MarketoLinkedServiceTypeProperties (required) |
MarketoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client Id of your Marketo service. | any (required) |
| clientSecret | The client secret of your Marketo service. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
Microsoft.DataFactory/factories/linkedservices
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: factories |
| properties | Properties of linked service. | LinkedService (required) |
MicrosoftAccessLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MicrosoftAccess' (required) |
| typeProperties | Microsoft Access linked service properties. | MicrosoftAccessLinkedServiceTypeProperties (required) |
MicrosoftAccessLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
MongoDbAtlasLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbAtlas' (required) |
| typeProperties | MongoDB Atlas linked service properties. | MongoDbAtlasLinkedServiceTypeProperties (required) |
MongoDbAtlasLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| driverVersion | The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string). | any |
MongoDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDb' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbLinkedServiceTypeProperties (required) |
MongoDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| authenticationType | The authentication type to be used to connect to the MongoDB database. | 'Anonymous' 'Basic' |
| authSource | Database to verify the username and password. Type: string (or Expression with resultType string). | any |
| databaseName | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| port | 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. | any |
| server | The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
MongoDbV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbV2' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbV2LinkedServiceTypeProperties (required) |
MongoDbV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
MySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MySql' (required) |
| typeProperties | MySQL linked service properties. | MySqlLinkedServiceTypeProperties (required) |
MySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowZeroDateTime | This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean. | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectionTimeout | The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer. | any |
| convertZeroDateTime | True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | 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. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| guidFormat | Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID. | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslCert | The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string. | any |
| sslKey | The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full. | any |
| treatTinyAsBoolean | When set to true, TINYINT(1) values are returned as booleans. Type: bool. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | Use system trust store for connection. Type: integer. 0: enable, 1: disable. | any |
NetezzaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Netezza' (required) |
| typeProperties | Netezza linked service properties. | NetezzaLinkedServiceTypeProperties (required) |
NetezzaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
ODataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OData' (required) |
| typeProperties | OData linked service properties. | ODataLinkedServiceTypeProperties (required) |
ODataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). | any |
| aadServicePrincipalCredentialType | Specify the credential type (key or cert) is used for service principal. | 'ServicePrincipalCert' 'ServicePrincipalKey' |
| authenticationType | Type of authentication used to connect to the OData service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| azureCloudType | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password of the OData service. | SecretBase |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| tenant | Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). | any |
| url | The URL of the OData service endpoint. Type: string (or Expression with resultType string). | any (required) |
| userName | User name of the OData service. Type: string (or Expression with resultType string). | any |
OdbcLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Odbc' (required) |
| typeProperties | ODBC linked service properties. | OdbcLinkedServiceTypeProperties (required) |
OdbcLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
Office365LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Office365' (required) |
| typeProperties | Office365 linked service properties. | Office365LinkedServiceTypeProperties (required) |
Office365LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| office365TenantId | Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | Specify the application's key. | SecretBase (required) |
| servicePrincipalTenantId | Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleCloudStorage' (required) |
| typeProperties | Oracle Cloud Storage linked service properties. | OracleCloudStorageLinkedServiceTypeProperties (required) |
OracleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
OracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Oracle' (required) |
| typeProperties | Oracle database linked service properties. | OracleLinkedServiceTypeProperties (required) |
OracleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
OracleServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleServiceCloud' (required) |
| typeProperties | Oracle Service Cloud linked service properties. | OracleServiceCloudLinkedServiceTypeProperties (required) |
OracleServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Oracle Service Cloud instance. | any (required) |
| password | The password corresponding to the user name that you provided in the username key. | SecretBase (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
| username | The user name that you use to access Oracle Service Cloud server. | any (required) |
ParameterDefinitionSpecification
| Name | Description | Value |
|---|
ParameterSpecification
| Name | Description | Value |
|---|---|---|
| defaultValue | Default value of parameter. | any |
| type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
| Name | Description | Value |
|---|
ParameterValueSpecification
| Name | Description | Value |
|---|
PaypalLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Paypal' (required) |
| typeProperties | Paypal Service linked service properties. | PaypalLinkedServiceTypeProperties (required) |
PaypalLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your PayPal application. | any (required) |
| clientSecret | The client secret associated with your PayPal application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
PhoenixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Phoenix' (required) |
| typeProperties | Phoenix server linked service properties. | PhoenixLinkedServiceTypeProperties (required) |
PhoenixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Phoenix server. | 'Anonymous' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Phoenix server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
PostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSql' (required) |
| typeProperties | PostgreSQL linked service properties. | PostgreSqlLinkedServiceTypeProperties (required) |
PostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
PostgreSqlV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSqlV2' (required) |
| typeProperties | PostgreSQLV2 linked service properties. | PostgreSqlV2LinkedServiceTypeProperties (required) |
PostgreSqlV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. Type: string. | any (required) |
| commandTimeout | 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. | any |
| connectionTimeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| database | Database name for connection. Type: string. | any (required) |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| logParameters | When enabled, parameter values are logged when commands are executed. Type: boolean. | any |
| password | The Azure key vault secret reference of password in connection string. Type: string. | AzureKeyVaultSecretReference |
| pooling | Whether connection pooling should be used. Type: boolean. | any |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| schema | Sets the schema search path. Type: string. | any |
| server | Server name for connection. Type: string. | any (required) |
| sslCertificate | Location of a client certificate to be sent to the server. Type: string. | any |
| sslKey | Location of a client key for a client certificate to be sent to the server. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any (required) |
| sslPassword | Password for a key for a client certificate. Type: string. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any (required) |
PrestoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Presto' (required) |
| typeProperties | Presto server linked service properties. | PrestoLinkedServiceTypeProperties (required) |
PrestoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Presto server. | 'Anonymous' 'LDAP' (required) |
| catalog | The catalog context for all request against the server. | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Presto server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Presto server uses to listen for client connections. The default value is 8080. | any |
| serverVersion | The version of the Presto server. (i.e. 0.148-t) | any (required) |
| timeZoneID | 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. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Presto server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
QuickbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Quickbase' (required) |
| typeProperties | Quickbase linked service properties. | QuickbaseLinkedServiceTypeProperties (required) |
QuickbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| url | The url to connect Quickbase source. Type: string (or Expression with resultType string). | any (required) |
| userToken | The user token for the Quickbase source. | SecretBase (required) |
QuickBooksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'QuickBooks' (required) |
| typeProperties | QuickBooks server linked service properties. | QuickBooksLinkedServiceTypeProperties (required) |
QuickBooksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for OAuth 1.0 authentication. | SecretBase |
| accessTokenSecret | The access token secret for OAuth 1.0 authentication. | SecretBase |
| companyId | The company ID of the QuickBooks company to authorize. | any |
| connectionProperties | Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key for OAuth 1.0 authentication. | any |
| consumerSecret | The consumer secret for OAuth 1.0 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
ResponsysLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Responsys' (required) |
| typeProperties | Responsys linked service properties. | ResponsysLinkedServiceTypeProperties (required) |
ResponsysLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Responsys application. Type: string (or Expression with resultType string). | any (required) |
| clientSecret | The client secret associated with the Responsys application. Type: string (or Expression with resultType string). | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Responsys server. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
RestServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'RestService' (required) |
| typeProperties | Rest Service linked service properties. | RestServiceLinkedServiceTypeProperties (required) |
RestServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | The resource you are requesting authorization to use. Type: string (or Expression with resultType string). | any |
| authenticationType | Type of authentication used to connect to the REST service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'OAuth2ClientCredential' (required) |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object). | any |
| azureCloudType | 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). | any |
| clientId | The client ID associated with your application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with your application. | SecretBase |
| credential | The credential reference containing authentication information. | CredentialReference |
| enableServerCertificateValidation | Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password used in Basic authentication type. | SecretBase |
| resource | The target service or resource to which the access will be requested. Type: string (or Expression with resultType string). | any |
| scope | The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string). | any |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The application's key used in AadServicePrincipal authentication type. | SecretBase |
| tenant | 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). | any |
| tokenEndpoint | The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string). | any |
| url | The base URL of the REST service. Type: string (or Expression with resultType string). | any (required) |
| userName | The user name used in Basic authentication type. Type: string (or Expression with resultType string). | any |
SalesforceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Salesforce' (required) |
| typeProperties | Salesforce linked service properties. | SalesforceLinkedServiceTypeProperties (required) |
SalesforceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceMarketingCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceMarketingCloud' (required) |
| typeProperties | Salesforce Marketing Cloud linked service properties. | SalesforceMarketingCloudLinkedServiceTypeProperties (required) |
SalesforceMarketingCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | SecretBase |
| connectionProperties | Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
SalesforceServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloud' (required) |
| typeProperties | Salesforce Service Cloud linked service properties. | SalesforceServiceCloudLinkedServiceTypeProperties (required) |
SalesforceServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| extendedProperties | Extended properties appended to the connection string. Type: string (or Expression with resultType string). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceServiceCloudV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloudV2' (required) |
| typeProperties | Salesforce Service Cloud V2 linked service properties. | SalesforceServiceCloudV2LinkedServiceTypeProperties (required) |
SalesforceServiceCloudV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SalesforceV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceV2' (required) |
| typeProperties | Salesforce V2 linked service properties. | SalesforceV2LinkedServiceTypeProperties (required) |
SalesforceV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SapBWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapBW' (required) |
| typeProperties | Properties specific to this linked service type. | SapBWLinkedServiceTypeProperties (required) |
SapBWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP BW server. | SecretBase |
| server | Host name of the SAP BW instance. Type: string (or Expression with resultType string). | any (required) |
| systemNumber | System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). | any (required) |
| userName | Username to access the SAP BW server. Type: string (or Expression with resultType string). | any |
SapCloudForCustomerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapCloudForCustomer' (required) |
| typeProperties | SAP Cloud for Customer linked service properties. | SapCloudForCustomerLinkedServiceTypeProperties (required) |
SapCloudForCustomerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | 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). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapEccLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapEcc' (required) |
| typeProperties | SAP ECC linked service properties. | SapEccLinkedServiceTypeProperties (required) |
SapEccLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapHanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapHana' (required) |
| typeProperties | Properties specific to this linked service type. | SapHanaLinkedServiceProperties (required) |
SapHanaLinkedServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the SAP HANA server. | 'Basic' 'Windows' |
| connectionString | SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP HANA server. | SecretBase |
| server | Host name of the SAP HANA server. Type: string (or Expression with resultType string). | any |
| userName | Username to access the SAP HANA server. Type: string (or Expression with resultType string). | any |
SapOdpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOdp' (required) |
| typeProperties | Properties specific to SAP ODP linked service type. | SapOdpLinkedServiceTypeProperties (required) |
SapOdpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| subscriberName | The subscriber name. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| x509CertificatePath | SNC X509 certificate file path. Type: string (or Expression with resultType string). | any |
SapOpenHubLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOpenHub' (required) |
| typeProperties | Properties specific to SAP Business Warehouse Open Hub Destination linked service type. | SapOpenHubLinkedServiceTypeProperties (required) |
SapOpenHubLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP BW server where the open hub destination is located. | SecretBase |
| server | Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string). | any |
SapTableLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapTable' (required) |
| typeProperties | Properties specific to this linked service type. | SapTableLinkedServiceTypeProperties (required) |
SapTableLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
ScriptAction
| Name | Description | Value |
|---|---|---|
| name | The user provided name of the script action. | string (required) |
| parameters | The parameters for the script action. | string |
| roles | The node types on which the script action should be executed. | any (required) |
| uri | The URI for the script action. | string (required) |
SecretBase
| Name | Description | Value |
|---|---|---|
| type | Set to 'AzureKeyVaultSecret' for type AzureKeyVaultSecretReference. Set to 'SecureString' for type SecureString. | 'AzureKeyVaultSecret' 'SecureString' (required) |
SecureString
| Name | Description | Value |
|---|---|---|
| type | Type of the secret. | 'SecureString' (required) |
| value | Value of secure string. | string (required) |
ServiceNowLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNow' (required) |
| typeProperties | ServiceNow server linked service properties. | ServiceNowLinkedServiceTypeProperties (required) |
ServiceNowLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com) | any (required) |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. | any |
ServiceNowV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNowV2' (required) |
| typeProperties | ServiceNowV2 server linked service properties. | ServiceNowV2LinkedServiceTypeProperties (required) |
ServiceNowV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNowV2 server. (i.e. <instance>.service-now.com) | any (required) |
| grantType | GrantType for OAuth2 authentication. Default value is password. | any |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| username | The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication. | any |
SftpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sftp' (required) |
| typeProperties | Properties specific to this linked service type. | SftpServerLinkedServiceTypeProperties (required) |
SftpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Basic' 'MultiFactor' 'SshPublicKey' |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The SFTP server host name. Type: string (or Expression with resultType string). | any (required) |
| hostKeyFingerprint | The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). | any |
| passPhrase | The password to decrypt the SSH private key if the SSH private key is encrypted. | SecretBase |
| password | Password to logon the SFTP server for Basic authentication. | SecretBase |
| port | 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. | any |
| privateKeyContent | 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. | SecretBase |
| privateKeyPath | 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). | any |
| skipHostKeyValidation | If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| userName | The username used to log on to the SFTP server. Type: string (or Expression with resultType string). | any |
SharePointOnlineListLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SharePointOnlineList' (required) |
| typeProperties | SharePoint Online List linked service properties. | SharePointOnlineListLinkedServiceTypeProperties (required) |
SharePointOnlineListLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | 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). | any (required) |
| servicePrincipalKey | The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| siteUrl | The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string). | any (required) |
| tenantId | 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). | any (required) |
ShopifyLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Shopify' (required) |
| typeProperties | Shopify Service linked service properties. | ShopifyLinkedServiceTypeProperties (required) |
ShopifyLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Shopify server. (i.e. mystore.myshopify.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SmartsheetLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Smartsheet' (required) |
| typeProperties | Smartsheet linked service properties. | SmartsheetLinkedServiceTypeProperties (required) |
SmartsheetLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Smartsheet source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
SnowflakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Snowflake' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedServiceTypeProperties (required) |
SnowflakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string of snowflake. Type: string, SecureString. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
SnowflakeLinkedV2ServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountIdentifier | The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure | any (required) |
| authenticationType | The type used for authentication. Type: string. | 'AADServicePrincipal' 'Basic' 'KeyPair' |
| clientId | The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| clientSecret | The Azure key vault secret reference of client secret for AADServicePrincipal authentication. | SecretBase |
| database | The name of the Snowflake database. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The host name of the Snowflake account. | any |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
| privateKey | The Azure key vault secret reference of privateKey for KeyPair auth. | SecretBase |
| privateKeyPassphrase | The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. | SecretBase |
| scope | The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| tenantId | The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| user | The name of the Snowflake user. | any |
| warehouse | The name of the Snowflake warehouse. | any (required) |
SnowflakeV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SnowflakeV2' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedV2ServiceTypeProperties (required) |
SparkLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Spark' (required) |
| typeProperties | Spark Server linked service properties. | SparkLinkedServiceTypeProperties (required) |
SparkLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Spark server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Spark server | any (required) |
| httpPath | The partial URL corresponding to the Spark server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Spark server uses to listen for client connections. | any (required) |
| serverType | The type of Spark server. | 'SharkServer' 'SharkServer2' 'SparkThriftServer' |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| username | The user name that you use to access Spark Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
SqlAlwaysEncryptedProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedAkvAuthType | Sql always encrypted AKV authentication type. Type: string. | 'ManagedIdentity' 'ServicePrincipal' 'UserAssignedManagedIdentity' (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure Key Vault. | SecretBase |
SqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SqlServer' (required) |
| typeProperties | SQL Server linked service properties. | SqlServerLinkedServiceTypeProperties (required) |
SqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'UserAssignedManagedIdentity' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
SquareLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Square' (required) |
| typeProperties | Square Service linked service properties. | SquareLinkedServiceTypeProperties (required) |
SquareLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your Square application. | any |
| clientSecret | The client secret associated with your Square application. | SecretBase |
| connectionProperties | Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Square instance. (i.e. mystore.mysquare.com) | any |
| redirectUri | The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SybaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sybase' (required) |
| typeProperties | Sybase linked service properties. | SybaseLinkedServiceTypeProperties (required) |
SybaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| schema | Schema name for connection. Type: string (or Expression with resultType string). | any |
| server | Server name for connection. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TeamDeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'TeamDesk' (required) |
| typeProperties | TeamDesk linked service properties. | TeamDeskLinkedServiceTypeProperties (required) |
TeamDeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the TeamDesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the TeamDesk source. | SecretBase |
| url | The url to connect TeamDesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the TeamDesk source. Type: string (or Expression with resultType string). | any |
TeradataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Teradata' (required) |
| typeProperties | Teradata linked service properties. | TeradataLinkedServiceTypeProperties (required) |
TeradataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| connectionString | Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TwilioLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Twilio' (required) |
| typeProperties | Twilio linked service properties. | TwilioLinkedServiceTypeProperties (required) |
TwilioLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| password | The auth token of Twilio service. | SecretBase (required) |
| userName | The Account SID of Twilio service. Type: string (or Expression with resultType string). | any (required) |
VerticaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Vertica' (required) |
| typeProperties | Vertica linked service properties. | VerticaLinkedServiceTypeProperties (required) |
VerticaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| port | The port for the connection. Type: integer. | any |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| server | Server name for connection. Type: string. | any |
| uid | Username for authentication. Type: string. | any |
WarehouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Warehouse' (required) |
| typeProperties | Microsoft Fabric Warehouse linked service properties. | WarehouseLinkedServiceTypeProperties (required) |
WarehouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
WebAnonymousAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Anonymous' (required) |
WebBasicAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Basic' (required) |
| password | The password for Basic authentication. | SecretBase (required) |
| username | User name for Basic authentication. Type: string (or Expression with resultType string). | any (required) |
WebClientCertificateAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'ClientCertificate' (required) |
| password | Password for the PFX file. | SecretBase (required) |
| pfx | Base64-encoded contents of a PFX file. | SecretBase (required) |
WebLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Web' (required) |
| typeProperties | Web linked service properties. | WebLinkedServiceTypeProperties (required) |
WebLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Set to 'Anonymous' for type WebAnonymousAuthentication. Set to 'Basic' for type WebBasicAuthentication. Set to 'ClientCertificate' for type WebClientCertificateAuthentication. | 'Anonymous' 'Basic' 'ClientCertificate' (required) |
| url | The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). | any (required) |
XeroLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Xero' (required) |
| typeProperties | Xero Service linked service properties. | XeroLinkedServiceTypeProperties (required) |
XeroLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionProperties | Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key associated with the Xero application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Xero server. (i.e. api.xero.com) | any |
| privateKey | 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( ). |
SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ZendeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zendesk' (required) |
| typeProperties | Zendesk linked service properties. | ZendeskLinkedServiceTypeProperties (required) |
ZendeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Zendesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Zendesk source. | SecretBase |
| url | The url to connect Zendesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the Zendesk source. Type: string (or Expression with resultType string). | any |
ZohoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zoho' (required) |
| typeProperties | Zoho server linked service properties. | ZohoLinkedServiceTypeProperties (required) |
ZohoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for Zoho authentication. | SecretBase |
| connectionProperties | Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create a V2 data factory | This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Deploy the Sports Analytics on Azure Architecture | Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| More is possible with Azure Data Factory - One click to try Azure Data Factory | This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
ARM template resource definition
The factories/linkedservices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories/linkedservices resource, add the following JSON to your template.
{
"type": "Microsoft.DataFactory/factories/linkedservices",
"apiVersion": "2018-06-01",
"name": "string",
"properties": {
"annotations": [ {} ],
"connectVia": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"description": "string",
"parameters": {
"{customized property}": {
"defaultValue": {},
"type": "string"
}
},
"version": "string",
"type": "string"
// For remaining properties, see LinkedService objects
}
}
LinkedService objects
Set the type property to specify the type of object.
For AmazonMWS, use:
{
"type": "AmazonMWS",
"typeProperties": {
"accessKeyId": {},
"encryptedCredential": "string",
"endpoint": {},
"marketplaceID": {},
"mwsAuthToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"secretKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"sellerID": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For AmazonRdsForOracle, use:
{
"type": "AmazonRdsForOracle",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
}
For AmazonRdsForSqlServer, use:
{
"type": "AmazonRdsForSqlServer",
"typeProperties": {
"alwaysEncryptedSettings": {
"alwaysEncryptedAkvAuthType": "string",
"credential": {
"referenceName": "string",
"type": "string"
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
}
},
"applicationIntent": {},
"authenticationType": "string",
"commandTimeout": {},
"connectionString": {},
"connectRetryCount": {},
"connectRetryInterval": {},
"connectTimeout": {},
"database": {},
"encrypt": {},
"encryptedCredential": "string",
"failoverPartner": {},
"hostNameInCertificate": {},
"integratedSecurity": {},
"loadBalanceTimeout": {},
"maxPoolSize": {},
"minPoolSize": {},
"multipleActiveResultSets": {},
"multiSubnetFailover": {},
"packetSize": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"pooling": {},
"server": {},
"trustServerCertificate": {},
"userName": {}
}
}
For AmazonRedshift, use:
{
"type": "AmazonRedshift",
"typeProperties": {
"database": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"server": {},
"username": {}
}
}
For AmazonS3, use:
{
"type": "AmazonS3",
"typeProperties": {
"accessKeyId": {},
"authenticationType": {},
"encryptedCredential": "string",
"secretAccessKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"serviceUrl": {},
"sessionToken": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
}
For AmazonS3Compatible, use:
{
"type": "AmazonS3Compatible",
"typeProperties": {
"accessKeyId": {},
"encryptedCredential": "string",
"forcePathStyle": {},
"secretAccessKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"serviceUrl": {}
}
}
For AppFigures, use:
{
"type": "AppFigures",
"typeProperties": {
"clientKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For Asana, use:
{
"type": "Asana",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string"
}
}
For AzureBatch, use:
{
"type": "AzureBatch",
"typeProperties": {
"accessKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"accountName": {},
"batchUri": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"poolName": {}
}
}
For AzureBlobFS, use:
{
"type": "AzureBlobFS",
"typeProperties": {
"accountKey": {},
"azureCloudType": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"sasToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"sasUri": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"url": {}
}
}
For AzureBlobStorage, use:
{
"type": "AzureBlobStorage",
"typeProperties": {
"accountKey": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"accountKind": {},
"authenticationType": "string",
"azureCloudType": {},
"connectionString": {},
"containerUri": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"sasToken": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"sasUri": {},
"serviceEndpoint": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {}
}
}
For AzureDataExplorer, use:
{
"type": "AzureDataExplorer",
"typeProperties": {
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"endpoint": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {}
}
}
For AzureDataLakeAnalytics, use:
{
"type": "AzureDataLakeAnalytics",
"typeProperties": {
"accountName": {},
"dataLakeAnalyticsUri": {},
"encryptedCredential": "string",
"resourceGroupName": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"subscriptionId": {},
"tenant": {}
}
}
For AzureDataLakeStore, use:
{
"type": "AzureDataLakeStore",
"typeProperties": {
"accountName": {},
"azureCloudType": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"dataLakeStoreUri": {},
"encryptedCredential": "string",
"resourceGroupName": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"subscriptionId": {},
"tenant": {}
}
}
For AzureDatabricks, use:
{
"type": "AzureDatabricks",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"authentication": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"domain": {},
"encryptedCredential": "string",
"existingClusterId": {},
"instancePoolId": {},
"newClusterCustomTags": {
"{customized property}": {}
},
"newClusterDriverNodeType": {},
"newClusterEnableElasticDisk": {},
"newClusterInitScripts": {},
"newClusterLogDestination": {},
"newClusterNodeType": {},
"newClusterNumOfWorker": {},
"newClusterSparkConf": {
"{customized property}": {}
},
"newClusterSparkEnvVars": {
"{customized property}": {}
},
"newClusterVersion": {},
"policyId": {},
"workspaceResourceId": {}
}
}
For AzureDatabricksDeltaLake, use:
{
"type": "AzureDatabricksDeltaLake",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"clusterId": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"domain": {},
"encryptedCredential": "string",
"workspaceResourceId": {}
}
}
For AzureFileStorage, use:
{
"type": "AzureFileStorage",
"typeProperties": {
"accountKey": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"connectionString": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"fileShare": {},
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"sasToken": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"sasUri": {},
"serviceEndpoint": {},
"snapshot": {},
"userId": {}
}
}
For AzureFunction, use:
{
"type": "AzureFunction",
"typeProperties": {
"authentication": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"functionAppUrl": {},
"functionKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"resourceId": {}
}
}
For AzureKeyVault, use:
{
"type": "AzureKeyVault",
"typeProperties": {
"baseUrl": {},
"credential": {
"referenceName": "string",
"type": "string"
}
}
}
For AzureML, use:
{
"type": "AzureML",
"typeProperties": {
"apiKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"authentication": {},
"encryptedCredential": "string",
"mlEndpoint": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"updateResourceEndpoint": {}
}
}
For AzureMLService, use:
{
"type": "AzureMLService",
"typeProperties": {
"authentication": {},
"encryptedCredential": "string",
"mlWorkspaceName": {},
"resourceGroupName": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"subscriptionId": {},
"tenant": {}
}
}
For AzureMariaDB, use:
{
"type": "AzureMariaDB",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"pwd": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For AzureMySql, use:
{
"type": "AzureMySql",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For AzurePostgreSql, use:
{
"type": "AzurePostgreSql",
"typeProperties": {
"commandTimeout": {},
"connectionString": {},
"database": {},
"encoding": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"port": {},
"readBufferSize": {},
"server": {},
"sslMode": {},
"timeout": {},
"timezone": {},
"trustServerCertificate": {},
"username": {}
}
}
For AzureSearch, use:
{
"type": "AzureSearch",
"typeProperties": {
"encryptedCredential": "string",
"key": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {}
}
}
For AzureSqlDW, use:
{
"type": "AzureSqlDW",
"typeProperties": {
"applicationIntent": {},
"authenticationType": "string",
"azureCloudType": {},
"commandTimeout": {},
"connectionString": {},
"connectRetryCount": {},
"connectRetryInterval": {},
"connectTimeout": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"encrypt": {},
"encryptedCredential": "string",
"failoverPartner": {},
"hostNameInCertificate": {},
"integratedSecurity": {},
"loadBalanceTimeout": {},
"maxPoolSize": {},
"minPoolSize": {},
"multipleActiveResultSets": {},
"multiSubnetFailover": {},
"packetSize": {},
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"pooling": {},
"server": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"trustServerCertificate": {},
"userName": {}
}
}
For AzureSqlDatabase, use:
{
"type": "AzureSqlDatabase",
"typeProperties": {
"alwaysEncryptedSettings": {
"alwaysEncryptedAkvAuthType": "string",
"credential": {
"referenceName": "string",
"type": "string"
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
}
},
"applicationIntent": {},
"authenticationType": "string",
"azureCloudType": {},
"commandTimeout": {},
"connectionString": {},
"connectRetryCount": {},
"connectRetryInterval": {},
"connectTimeout": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"encrypt": {},
"encryptedCredential": "string",
"failoverPartner": {},
"hostNameInCertificate": {},
"integratedSecurity": {},
"loadBalanceTimeout": {},
"maxPoolSize": {},
"minPoolSize": {},
"multipleActiveResultSets": {},
"multiSubnetFailover": {},
"packetSize": {},
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"pooling": {},
"server": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"trustServerCertificate": {},
"userName": {}
}
}
For AzureSqlMI, use:
{
"type": "AzureSqlMI",
"typeProperties": {
"alwaysEncryptedSettings": {
"alwaysEncryptedAkvAuthType": "string",
"credential": {
"referenceName": "string",
"type": "string"
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
}
},
"applicationIntent": {},
"authenticationType": "string",
"azureCloudType": {},
"commandTimeout": {},
"connectionString": {},
"connectRetryCount": {},
"connectRetryInterval": {},
"connectTimeout": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"encrypt": {},
"encryptedCredential": "string",
"failoverPartner": {},
"hostNameInCertificate": {},
"integratedSecurity": {},
"loadBalanceTimeout": {},
"maxPoolSize": {},
"minPoolSize": {},
"multipleActiveResultSets": {},
"multiSubnetFailover": {},
"packetSize": {},
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"pooling": {},
"server": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"trustServerCertificate": {},
"userName": {}
}
}
For AzureStorage, use:
{
"type": "AzureStorage",
"typeProperties": {
"accountKey": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"connectionString": {},
"encryptedCredential": "string",
"sasToken": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"sasUri": {}
}
}
For AzureSynapseArtifacts, use:
{
"type": "AzureSynapseArtifacts",
"typeProperties": {
"authentication": {},
"endpoint": {},
"workspaceResourceId": {}
}
}
For AzureTableStorage, use:
{
"type": "AzureTableStorage",
"typeProperties": {
"accountKey": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"connectionString": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"encryptedCredential": "string",
"sasToken": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"sasUri": {},
"serviceEndpoint": {}
}
}
For Cassandra, use:
{
"type": "Cassandra",
"typeProperties": {
"authenticationType": {},
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"username": {}
}
}
For CommonDataServiceForApps, use:
{
"type": "CommonDataServiceForApps",
"typeProperties": {
"authenticationType": {},
"deploymentType": {},
"domain": {},
"encryptedCredential": "string",
"hostName": {},
"organizationName": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"serviceUri": {},
"username": {}
}
}
For Concur, use:
{
"type": "Concur",
"typeProperties": {
"clientId": {},
"connectionProperties": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {},
"username": {}
}
}
For CosmosDb, use:
{
"type": "CosmosDb",
"typeProperties": {
"accountEndpoint": {},
"accountKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"azureCloudType": {},
"connectionMode": "string",
"connectionString": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"encryptedCredential": "string",
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"tenant": {}
}
}
For CosmosDbMongoDbApi, use:
{
"type": "CosmosDbMongoDbApi",
"typeProperties": {
"connectionString": {},
"database": {},
"isServerVersionAbove32": {}
}
}
For Couchbase, use:
{
"type": "Couchbase",
"typeProperties": {
"connectionString": {},
"credString": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"encryptedCredential": "string"
}
}
For CustomDataSource, use:
{
"type": "CustomDataSource",
"typeProperties": {}
}
For Dataworld, use:
{
"type": "Dataworld",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string"
}
}
For Db2, use:
{
"type": "Db2",
"typeProperties": {
"authenticationType": "string",
"certificateCommonName": {},
"connectionString": {},
"database": {},
"encryptedCredential": "string",
"packageCollection": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"username": {}
}
}
For Drill, use:
{
"type": "Drill",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"pwd": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For Dynamics, use:
{
"type": "Dynamics",
"typeProperties": {
"authenticationType": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"deploymentType": {},
"domain": {},
"encryptedCredential": "string",
"hostName": {},
"organizationName": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"serviceUri": {},
"username": {}
}
}
For DynamicsAX, use:
{
"type": "DynamicsAX",
"typeProperties": {
"aadResourceId": {},
"encryptedCredential": "string",
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"url": {}
}
}
For DynamicsCrm, use:
{
"type": "DynamicsCrm",
"typeProperties": {
"authenticationType": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"deploymentType": {},
"domain": {},
"encryptedCredential": "string",
"hostName": {},
"organizationName": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"serviceUri": {},
"username": {}
}
}
For Eloqua, use:
{
"type": "Eloqua",
"typeProperties": {
"encryptedCredential": "string",
"endpoint": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {},
"username": {}
}
}
For FileServer, use:
{
"type": "FileServer",
"typeProperties": {
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userId": {}
}
}
For FtpServer, use:
{
"type": "FtpServer",
"typeProperties": {
"authenticationType": "string",
"enableServerCertificateValidation": {},
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"userName": {}
}
}
For GoogleAdWords, use:
{
"type": "GoogleAdWords",
"typeProperties": {
"authenticationType": "string",
"clientCustomerID": {},
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"connectionProperties": {},
"developerToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"email": {},
"encryptedCredential": "string",
"googleAdsApiVersion": {},
"keyFilePath": {},
"loginCustomerID": {},
"privateKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"refreshToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"supportLegacyDataTypes": {},
"trustedCertPath": {},
"useSystemTrustStore": {}
}
}
For GoogleBigQuery, use:
{
"type": "GoogleBigQuery",
"typeProperties": {
"additionalProjects": {},
"authenticationType": "string",
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"email": {},
"encryptedCredential": "string",
"keyFilePath": {},
"project": {},
"refreshToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"requestGoogleDriveScope": {},
"trustedCertPath": {},
"useSystemTrustStore": {}
}
}
For GoogleBigQueryV2, use:
{
"type": "GoogleBigQueryV2",
"typeProperties": {
"authenticationType": "string",
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"keyFileContent": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"projectId": {},
"refreshToken": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
}
For GoogleCloudStorage, use:
{
"type": "GoogleCloudStorage",
"typeProperties": {
"accessKeyId": {},
"encryptedCredential": "string",
"secretAccessKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"serviceUrl": {}
}
}
For GoogleSheets, use:
{
"type": "GoogleSheets",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string"
}
}
For Greenplum, use:
{
"type": "Greenplum",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"pwd": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For HBase, use:
{
"type": "HBase",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"httpPath": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"trustedCertPath": {},
"username": {}
}
}
For HDInsight, use:
{
"type": "HDInsight",
"typeProperties": {
"clusterUri": {},
"encryptedCredential": "string",
"fileSystem": {},
"hcatalogLinkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"isEspEnabled": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For HDInsightOnDemand, use:
{
"type": "HDInsightOnDemand",
"typeProperties": {
"additionalLinkedServiceNames": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"clusterNamePrefix": {},
"clusterPassword": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"clusterResourceGroup": {},
"clusterSize": {},
"clusterSshPassword": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"clusterSshUserName": {},
"clusterType": {},
"clusterUserName": {},
"coreConfiguration": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"dataNodeSize": {},
"encryptedCredential": "string",
"hBaseConfiguration": {},
"hcatalogLinkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"hdfsConfiguration": {},
"headNodeSize": {},
"hiveConfiguration": {},
"hostSubscriptionId": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"mapReduceConfiguration": {},
"oozieConfiguration": {},
"scriptActions": [
{
"name": "string",
"parameters": "string",
"roles": {},
"uri": "string"
}
],
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"sparkVersion": {},
"stormConfiguration": {},
"subnetName": {},
"tenant": {},
"timeToLive": {},
"version": {},
"virtualNetworkId": {},
"yarnConfiguration": {},
"zookeeperNodeSize": {}
}
}
For Hdfs, use:
{
"type": "Hdfs",
"typeProperties": {
"authenticationType": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"userName": {}
}
}
For Hive, use:
{
"type": "Hive",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"httpPath": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"serverType": "string",
"serviceDiscoveryMode": {},
"thriftTransportProtocol": "string",
"trustedCertPath": {},
"useNativeQuery": {},
"username": {},
"useSystemTrustStore": {},
"zooKeeperNameSpace": {}
}
}
For HttpServer, use:
{
"type": "HttpServer",
"typeProperties": {
"authenticationType": "string",
"authHeaders": {},
"certThumbprint": {},
"embeddedCertData": {},
"enableServerCertificateValidation": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"userName": {}
}
}
For Hubspot, use:
{
"type": "Hubspot",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"refreshToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For Impala, use:
{
"type": "Impala",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"trustedCertPath": {},
"username": {},
"useSystemTrustStore": {}
}
}
For Informix, use:
{
"type": "Informix",
"typeProperties": {
"authenticationType": {},
"connectionString": {},
"credential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For Jira, use:
{
"type": "Jira",
"typeProperties": {
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {},
"username": {}
}
}
For LakeHouse, use:
{
"type": "LakeHouse",
"typeProperties": {
"artifactId": {},
"encryptedCredential": "string",
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"workspaceId": {}
}
}
For Magento, use:
{
"type": "Magento",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"host": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For MariaDB, use:
{
"type": "MariaDB",
"typeProperties": {
"connectionString": {},
"database": {},
"driverVersion": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"port": {},
"server": {},
"sslMode": {},
"username": {},
"useSystemTrustStore": {}
}
}
For Marketo, use:
{
"type": "Marketo",
"typeProperties": {
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"endpoint": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For MicrosoftAccess, use:
{
"type": "MicrosoftAccess",
"typeProperties": {
"authenticationType": {},
"connectionString": {},
"credential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For MongoDb, use:
{
"type": "MongoDb",
"typeProperties": {
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"authSource": {},
"databaseName": {},
"enableSsl": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"server": {},
"username": {}
}
}
For MongoDbAtlas, use:
{
"type": "MongoDbAtlas",
"typeProperties": {
"connectionString": {},
"database": {},
"driverVersion": {}
}
}
For MongoDbV2, use:
{
"type": "MongoDbV2",
"typeProperties": {
"connectionString": {},
"database": {}
}
}
For MySql, use:
{
"type": "MySql",
"typeProperties": {
"allowZeroDateTime": {},
"connectionString": {},
"connectionTimeout": {},
"convertZeroDateTime": {},
"database": {},
"driverVersion": {},
"encryptedCredential": "string",
"guidFormat": {},
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"port": {},
"server": {},
"sslCert": {},
"sslKey": {},
"sslMode": {},
"treatTinyAsBoolean": {},
"username": {},
"useSystemTrustStore": {}
}
}
For Netezza, use:
{
"type": "Netezza",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"pwd": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For OData, use:
{
"type": "OData",
"typeProperties": {
"aadResourceId": {},
"aadServicePrincipalCredentialType": "string",
"authenticationType": "string",
"authHeaders": {},
"azureCloudType": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalEmbeddedCert": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalEmbeddedCertPassword": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"url": {},
"userName": {}
}
}
For Odbc, use:
{
"type": "Odbc",
"typeProperties": {
"authenticationType": {},
"connectionString": {},
"credential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For Office365, use:
{
"type": "Office365",
"typeProperties": {
"encryptedCredential": "string",
"office365TenantId": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalTenantId": {}
}
}
For Oracle, use:
{
"type": "Oracle",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For OracleCloudStorage, use:
{
"type": "OracleCloudStorage",
"typeProperties": {
"accessKeyId": {},
"encryptedCredential": "string",
"secretAccessKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"serviceUrl": {}
}
}
For OracleServiceCloud, use:
{
"type": "OracleServiceCloud",
"typeProperties": {
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {},
"username": {}
}
}
For Paypal, use:
{
"type": "Paypal",
"typeProperties": {
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"host": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For Phoenix, use:
{
"type": "Phoenix",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"httpPath": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"trustedCertPath": {},
"username": {},
"useSystemTrustStore": {}
}
}
For PostgreSql, use:
{
"type": "PostgreSql",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For PostgreSqlV2, use:
{
"type": "PostgreSqlV2",
"typeProperties": {
"authenticationType": {},
"commandTimeout": {},
"connectionTimeout": {},
"database": {},
"encoding": {},
"encryptedCredential": "string",
"logParameters": {},
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"pooling": {},
"port": {},
"readBufferSize": {},
"schema": {},
"server": {},
"sslCertificate": {},
"sslKey": {},
"sslMode": {},
"sslPassword": {},
"timezone": {},
"trustServerCertificate": {},
"username": {}
}
}
For Presto, use:
{
"type": "Presto",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"catalog": {},
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"serverVersion": {},
"timeZoneID": {},
"trustedCertPath": {},
"username": {},
"useSystemTrustStore": {}
}
}
For QuickBooks, use:
{
"type": "QuickBooks",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"accessTokenSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"companyId": {},
"connectionProperties": {},
"consumerKey": {},
"consumerSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"endpoint": {},
"useEncryptedEndpoints": {}
}
}
For Quickbase, use:
{
"type": "Quickbase",
"typeProperties": {
"encryptedCredential": "string",
"url": {},
"userToken": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
}
For Responsys, use:
{
"type": "Responsys",
"typeProperties": {
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"endpoint": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For RestService, use:
{
"type": "RestService",
"typeProperties": {
"aadResourceId": {},
"authenticationType": "string",
"authHeaders": {},
"azureCloudType": {},
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"credential": {
"referenceName": "string",
"type": "string"
},
"enableServerCertificateValidation": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"resource": {},
"scope": {},
"servicePrincipalCredentialType": {},
"servicePrincipalEmbeddedCert": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalEmbeddedCertPassword": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"tokenEndpoint": {},
"url": {},
"userName": {}
}
}
For Salesforce, use:
{
"type": "Salesforce",
"typeProperties": {
"apiVersion": {},
"encryptedCredential": "string",
"environmentUrl": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"securityToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"username": {}
}
}
For SalesforceMarketingCloud, use:
{
"type": "SalesforceMarketingCloud",
"typeProperties": {
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"connectionProperties": {},
"encryptedCredential": "string",
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For SalesforceServiceCloud, use:
{
"type": "SalesforceServiceCloud",
"typeProperties": {
"apiVersion": {},
"encryptedCredential": "string",
"environmentUrl": {},
"extendedProperties": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"securityToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"username": {}
}
}
For SalesforceServiceCloudV2, use:
{
"type": "SalesforceServiceCloudV2",
"typeProperties": {
"apiVersion": {},
"authenticationType": {},
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"environmentUrl": {}
}
}
For SalesforceV2, use:
{
"type": "SalesforceV2",
"typeProperties": {
"apiVersion": {},
"authenticationType": {},
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"environmentUrl": {}
}
}
For SapBW, use:
{
"type": "SapBW",
"typeProperties": {
"clientId": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"systemNumber": {},
"userName": {}
}
}
For SapCloudForCustomer, use:
{
"type": "SapCloudForCustomer",
"typeProperties": {
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"username": {}
}
}
For SapEcc, use:
{
"type": "SapEcc",
"typeProperties": {
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"username": {}
}
}
For SapHana, use:
{
"type": "SapHana",
"typeProperties": {
"authenticationType": "string",
"connectionString": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"userName": {}
}
}
For SapOdp, use:
{
"type": "SapOdp",
"typeProperties": {
"clientId": {},
"encryptedCredential": "string",
"language": {},
"logonGroup": {},
"messageServer": {},
"messageServerService": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"sncLibraryPath": {},
"sncMode": {},
"sncMyName": {},
"sncPartnerName": {},
"sncQop": {},
"subscriberName": {},
"systemId": {},
"systemNumber": {},
"userName": {},
"x509CertificatePath": {}
}
}
For SapOpenHub, use:
{
"type": "SapOpenHub",
"typeProperties": {
"clientId": {},
"encryptedCredential": "string",
"language": {},
"logonGroup": {},
"messageServer": {},
"messageServerService": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"systemId": {},
"systemNumber": {},
"userName": {}
}
}
For SapTable, use:
{
"type": "SapTable",
"typeProperties": {
"clientId": {},
"encryptedCredential": "string",
"language": {},
"logonGroup": {},
"messageServer": {},
"messageServerService": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"sncLibraryPath": {},
"sncMode": {},
"sncMyName": {},
"sncPartnerName": {},
"sncQop": {},
"systemId": {},
"systemNumber": {},
"userName": {}
}
}
For ServiceNow, use:
{
"type": "ServiceNow",
"typeProperties": {
"authenticationType": "string",
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"endpoint": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {},
"username": {}
}
}
For ServiceNowV2, use:
{
"type": "ServiceNowV2",
"typeProperties": {
"authenticationType": "string",
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"endpoint": {},
"grantType": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"username": {}
}
}
For Sftp, use:
{
"type": "Sftp",
"typeProperties": {
"authenticationType": "string",
"encryptedCredential": "string",
"host": {},
"hostKeyFingerprint": {},
"passPhrase": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"privateKeyContent": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"privateKeyPath": {},
"skipHostKeyValidation": {},
"userName": {}
}
}
For SharePointOnlineList, use:
{
"type": "SharePointOnlineList",
"typeProperties": {
"encryptedCredential": "string",
"servicePrincipalCredentialType": {},
"servicePrincipalEmbeddedCert": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalEmbeddedCertPassword": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"siteUrl": {},
"tenantId": {}
}
}
For Shopify, use:
{
"type": "Shopify",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"host": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For Smartsheet, use:
{
"type": "Smartsheet",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string"
}
}
For Snowflake, use:
{
"type": "Snowflake",
"typeProperties": {
"connectionString": {},
"encryptedCredential": "string",
"password": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
}
}
}
For SnowflakeV2, use:
{
"type": "SnowflakeV2",
"typeProperties": {
"accountIdentifier": {},
"authenticationType": "string",
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"database": {},
"encryptedCredential": "string",
"host": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"privateKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"privateKeyPassphrase": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"scope": {},
"tenantId": {},
"user": {},
"warehouse": {}
}
}
For Spark, use:
{
"type": "Spark",
"typeProperties": {
"allowHostNameCNMismatch": {},
"allowSelfSignedServerCert": {},
"authenticationType": "string",
"enableSsl": {},
"encryptedCredential": "string",
"host": {},
"httpPath": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"port": {},
"serverType": "string",
"thriftTransportProtocol": "string",
"trustedCertPath": {},
"username": {},
"useSystemTrustStore": {}
}
}
For SqlServer, use:
{
"type": "SqlServer",
"typeProperties": {
"alwaysEncryptedSettings": {
"alwaysEncryptedAkvAuthType": "string",
"credential": {
"referenceName": "string",
"type": "string"
},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
}
},
"applicationIntent": {},
"authenticationType": "string",
"commandTimeout": {},
"connectionString": {},
"connectRetryCount": {},
"connectRetryInterval": {},
"connectTimeout": {},
"credential": {
"referenceName": "string",
"type": "string"
},
"database": {},
"encrypt": {},
"encryptedCredential": "string",
"failoverPartner": {},
"hostNameInCertificate": {},
"integratedSecurity": {},
"loadBalanceTimeout": {},
"maxPoolSize": {},
"minPoolSize": {},
"multipleActiveResultSets": {},
"multiSubnetFailover": {},
"packetSize": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"pooling": {},
"server": {},
"trustServerCertificate": {},
"userName": {}
}
}
For Square, use:
{
"type": "Square",
"typeProperties": {
"clientId": {},
"clientSecret": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"connectionProperties": {},
"encryptedCredential": "string",
"host": {},
"redirectUri": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For Sybase, use:
{
"type": "Sybase",
"typeProperties": {
"authenticationType": "string",
"database": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"schema": {},
"server": {},
"username": {}
}
}
For TeamDesk, use:
{
"type": "TeamDesk",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"authenticationType": "string",
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"userName": {}
}
}
For Teradata, use:
{
"type": "Teradata",
"typeProperties": {
"authenticationType": "string",
"connectionString": {},
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"server": {},
"username": {}
}
}
For Twilio, use:
{
"type": "Twilio",
"typeProperties": {
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
}
}
For Vertica, use:
{
"type": "Vertica",
"typeProperties": {
"connectionString": {},
"database": {},
"encryptedCredential": "string",
"port": {},
"pwd": {
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "string"
},
"server": {},
"uid": {}
}
}
For Warehouse, use:
{
"type": "Warehouse",
"typeProperties": {
"artifactId": {},
"encryptedCredential": "string",
"endpoint": {},
"servicePrincipalCredential": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"servicePrincipalCredentialType": {},
"servicePrincipalId": {},
"servicePrincipalKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"tenant": {},
"workspaceId": {}
}
}
For Web, use:
{
"type": "Web",
"typeProperties": {
"url": {},
"authenticationType": "string"
// For remaining properties, see WebLinkedServiceTypeProperties objects
}
}
For Xero, use:
{
"type": "Xero",
"typeProperties": {
"connectionProperties": {},
"consumerKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"encryptedCredential": "string",
"host": {},
"privateKey": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
For Zendesk, use:
{
"type": "Zendesk",
"typeProperties": {
"apiToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"authenticationType": "string",
"encryptedCredential": "string",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"url": {},
"userName": {}
}
}
For Zoho, use:
{
"type": "Zoho",
"typeProperties": {
"accessToken": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"connectionProperties": {},
"encryptedCredential": "string",
"endpoint": {},
"useEncryptedEndpoints": {},
"useHostVerification": {},
"usePeerVerification": {}
}
}
SecretBase objects
Set the type property to specify the type of object.
For AzureKeyVaultSecret, use:
{
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "AzureKeyVaultSecret"
}
For SecureString, use:
{
"type": "SecureString",
"value": "string"
}
WebLinkedServiceTypeProperties objects
Set the authenticationType property to specify the type of object.
For Anonymous, use:
{
"authenticationType": "Anonymous"
}
For Basic, use:
{
"authenticationType": "Basic",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"username": {}
}
For ClientCertificate, use:
{
"authenticationType": "ClientCertificate",
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"pfx": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
Property values
AmazonMWSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonMWS' (required) |
| typeProperties | Amazon Marketplace Web Service linked service properties. | AmazonMWSLinkedServiceTypeProperties (required) |
AmazonMWSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key id used to access data. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) | any (required) |
| marketplaceID | 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) | any (required) |
| mwsAuthToken | The Amazon MWS authentication token. | SecretBase |
| secretKey | The secret key used to access data. | SecretBase |
| sellerID | The Amazon seller ID. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
AmazonRdsForLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
AmazonRdsForOracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForOracle' (required) |
| typeProperties | AmazonRdsForOracle database linked service properties. | AmazonRdsForLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForSqlServer' (required) |
| typeProperties | Amazon RDS for SQL Server linked service properties. | AmazonRdsForSqlServerLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
AmazonRedshiftLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRedshift' (required) |
| typeProperties | Amazon Redshift linked service properties. | AmazonRedshiftLinkedServiceTypeProperties (required) |
AmazonRedshiftLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| database | The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Amazon Redshift source. | SecretBase |
| port | 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). | any |
| server | The name of the Amazon Redshift server. Type: string (or Expression with resultType string). | any (required) |
| username | The username of the Amazon Redshift source. Type: string (or Expression with resultType string). | any |
AmazonS3CompatibleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3Compatible' (required) |
| typeProperties | Amazon S3 Compatible linked service properties. | AmazonS3CompatibleLinkedServiceTypeProperties (required) |
AmazonS3CompatibleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| forcePathStyle | If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| secretAccessKey | The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
AmazonS3LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3' (required) |
| typeProperties | Amazon S3 linked service properties. | AmazonS3LinkedServiceTypeProperties (required) |
AmazonS3LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| authenticationType | The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Amazon S3 Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
| sessionToken | The session token for the S3 temporary security credential. | SecretBase |
AppFiguresLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AppFigures' (required) |
| typeProperties | AppFigures linked service properties. | AppFiguresLinkedServiceTypeProperties (required) |
AppFiguresLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientKey | The client key for the AppFigures source. | SecretBase (required) |
| password | The password of the AppFigures source. | SecretBase (required) |
| userName | The username of the Appfigures source. Type: string (or Expression with resultType string). | any (required) |
AsanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Asana' (required) |
| typeProperties | Asana linked service properties. | AsanaLinkedServiceTypeProperties (required) |
AsanaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Asana source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
AzureBatchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBatch' (required) |
| typeProperties | Azure Batch linked service properties. | AzureBatchLinkedServiceTypeProperties (required) |
AzureBatchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKey | The Azure Batch account access key. | SecretBase |
| accountName | The Azure Batch account name. Type: string (or Expression with resultType string). | any (required) |
| batchUri | The Azure Batch URI. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference (required) |
| poolName | The Azure Batch pool name. Type: string (or Expression with resultType string). | any (required) |
AzureBlobFSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobFS' (required) |
| typeProperties | Azure Data Lake Storage Gen2 linked service properties. | AzureBlobFSLinkedServiceTypeProperties (required) |
AzureBlobFSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | SecretBase |
| sasUri | SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| url | Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
AzureBlobStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobStorage' (required) |
| typeProperties | Azure Blob Storage linked service properties. | AzureBlobStorageLinkedServiceTypeProperties (required) |
AzureBlobStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| accountKind | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'AccountKey' 'Anonymous' 'Msi' 'SasUri' 'ServicePrincipal' |
| azureCloudType | 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). | any |
| connectionString | The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| containerUri | Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDatabricksDeltaLakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricksDeltaLake' (required) |
| typeProperties | Azure Databricks Delta Lake linked service properties. | AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required) |
AzureDatabricksDetltaLakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. | SecretBase |
| clusterId | The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricks' (required) |
| typeProperties | Azure Databricks linked service properties. | AzureDatabricksLinkedServiceTypeProperties (required) |
AzureDatabricksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string). | SecretBase |
| authentication | Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| existingClusterId | The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| instancePoolId | The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| newClusterCustomTags | Additional tags for cluster resources. This property is ignored in instance pool configurations. | AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags |
| newClusterDriverNodeType | The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string). | any |
| newClusterEnableElasticDisk | 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). | any |
| newClusterInitScripts | User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings). | any |
| newClusterLogDestination | Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string). | any |
| newClusterNodeType | 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). | any |
| newClusterNumOfWorker | 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). | any |
| newClusterSparkConf | A set of optional, user-specified Spark configuration key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf |
| newClusterSparkEnvVars | A set of optional, user-specified Spark environment variables key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars |
| newClusterVersion | 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). | any |
| policyId | 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). | any |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars
| Name | Description | Value |
|---|
AzureDataExplorerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataExplorer' (required) |
| typeProperties | Azure Data Explorer (Kusto) linked service properties. | AzureDataExplorerLinkedServiceTypeProperties (required) |
AzureDataExplorerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| credential | The credential reference containing authentication information. | CredentialReference |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| endpoint | The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://<clusterName>.<regionName>.kusto.windows.net. Type: string (or Expression with resultType string) | any (required) |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Kusto. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDataLakeAnalyticsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeAnalytics' (required) |
| typeProperties | Azure Data Lake Analytics linked service properties. | AzureDataLakeAnalyticsLinkedServiceTypeProperties (required) |
AzureDataLakeAnalyticsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string). | any (required) |
| dataLakeAnalyticsUri | Azure Data Lake Analytics URI Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Analytics account. | SecretBase |
| subscriptionId | Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
AzureDataLakeStoreLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeStore' (required) |
| typeProperties | Azure Data Lake Store linked service properties. | AzureDataLakeStoreLinkedServiceTypeProperties (required) |
AzureDataLakeStoreLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | Data Lake Store account name. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataLakeStoreUri | Data Lake Store service URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Store account. | SecretBase |
| subscriptionId | Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureFileStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFileStorage' (required) |
| typeProperties | Azure File Storage linked service properties. | AzureFileStorageLinkedServiceTypeProperties (required) |
AzureFileStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileShare | The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string). | any |
| host | Host name of the server. Type: string (or Expression with resultType string). | any |
| password | Password to logon the server. | SecretBase |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| snapshot | The azure file share snapshot version. Type: string (or Expression with resultType string). | any |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
AzureFunctionLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFunction' (required) |
| typeProperties | Azure Function linked service properties. | AzureFunctionLinkedServiceTypeProperties (required) |
AzureFunctionLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| functionAppUrl | The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string). | any (required) |
| functionKey | Function or Host key for Azure Function App. | SecretBase |
| resourceId | Allowed token audiences for azure function. Type: string (or Expression with resultType string). | any |
AzureKeyVaultLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureKeyVault' (required) |
| typeProperties | Azure Key Vault linked service properties. | AzureKeyVaultLinkedServiceTypeProperties (required) |
AzureKeyVaultLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| baseUrl | The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | string (required) |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | 'AzureKeyVaultSecret' (required) |
AzureMariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMariaDB' (required) |
| typeProperties | Azure Database for MariaDB linked service properties. | AzureMariaDBLinkedServiceTypeProperties (required) |
AzureMariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzureMLLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureML' (required) |
| typeProperties | Azure ML Studio Web Service linked service properties. | AzureMLLinkedServiceTypeProperties (required) |
AzureMLLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The API key for accessing the Azure ML model endpoint. | SecretBase (required) |
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlEndpoint | The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| updateResourceEndpoint | The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any |
AzureMLServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMLService' (required) |
| typeProperties | Azure ML Service linked service properties. | AzureMLServiceLinkedServiceTypeProperties (required) |
AzureMLServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlWorkspaceName | Azure ML Service workspace name. Type: string (or Expression with resultType string). | any (required) |
| resourceGroupName | Azure ML Service workspace resource group name. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. | SecretBase |
| subscriptionId | Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string). | any (required) |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureMySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMySql' (required) |
| typeProperties | Azure MySQL database linked service properties. | AzureMySqlLinkedServiceTypeProperties (required) |
AzureMySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzurePostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzurePostgreSql' (required) |
| typeProperties | Azure PostgreSQL linked service properties. | AzurePostgreSqlLinkedServiceTypeProperties (required) |
AzurePostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| commandTimeout | 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. | any |
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any |
| timeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any |
AzureSearchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSearch' (required) |
| typeProperties | Windows Azure Search Service linked service properties. | AzureSearchLinkedServiceTypeProperties (required) |
AzureSearchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| key | Admin Key for Azure Search service | SecretBase |
| url | URL for Azure Search service. Type: string (or Expression with resultType string). | any (required) |
AzureSqlDatabaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDatabase' (required) |
| typeProperties | Azure SQL Database linked service properties. | AzureSqlDatabaseLinkedServiceTypeProperties (required) |
AzureSqlDatabaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Database. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlDWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDW' (required) |
| typeProperties | Azure SQL Data Warehouse linked service properties. | AzureSqlDWLinkedServiceTypeProperties (required) |
AzureSqlDWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlMILinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlMI' (required) |
| typeProperties | Azure SQL Managed Instance linked service properties. | AzureSqlMILinkedServiceTypeProperties (required) |
AzureSqlMILinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Managed Instance. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureStorage' (required) |
| typeProperties | Azure Storage linked service properties. | AzureStorageLinkedServiceTypeProperties (required) |
AzureStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
AzureSynapseArtifactsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSynapseArtifacts' (required) |
| typeProperties | Azure Synapse Analytics (Artifacts) linked service properties. | AzureSynapseArtifactsLinkedServiceTypeProperties (required) |
AzureSynapseArtifactsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string). | any |
| endpoint | https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string). | any (required) |
| workspaceResourceId | 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). | any |
AzureTableStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureTableStorage' (required) |
| typeProperties | Azure Table Storage linked service properties. | AzureTableStorageLinkedServiceTypeProperties (required) |
AzureTableStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
CassandraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Cassandra' (required) |
| typeProperties | Cassandra linked service properties. | CassandraLinkedServiceTypeProperties (required) |
CassandraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name for connection. Type: string (or Expression with resultType string). | any (required) |
| password | Password for authentication. | SecretBase |
| port | The port for the connection. Type: integer (or Expression with resultType integer). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
CommonDataServiceForAppsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CommonDataServiceForApps' (required) |
| typeProperties | Common Data Service for Apps linked service properties. | CommonDataServiceForAppsLinkedServiceTypeProperties (required) |
CommonDataServiceForAppsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Common Data Service for Apps instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). | any |
ConcurLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Concur' (required) |
| typeProperties | Concur Service linked service properties. | ConcurLinkedServiceTypeProperties (required) |
ConcurLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | Application client_id supplied by Concur App Management. | any (required) |
| connectionProperties | Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Concur Service. | any (required) |
CosmosDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDb' (required) |
| typeProperties | CosmosDB linked service properties. | CosmosDbLinkedServiceTypeProperties (required) |
CosmosDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountEndpoint | The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) | any |
| accountKey | The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. | SecretBase |
| azureCloudType | 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). | any |
| connectionMode | The connection mode used to access CosmosDB account. Type: string. | 'Direct' 'Gateway' |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database. Type: string (or Expression with resultType string) | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
CosmosDbMongoDbApiLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDbMongoDbApi' (required) |
| typeProperties | CosmosDB (MongoDB API) linked service properties. | CosmosDbMongoDbApiLinkedServiceTypeProperties (required) |
CosmosDbMongoDbApiLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| isServerVersionAbove32 | Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
CouchbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Couchbase' (required) |
| typeProperties | Couchbase server linked service properties. | CouchbaseLinkedServiceTypeProperties (required) |
CouchbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credString | The Azure key vault secret reference of credString in connection string. | AzureKeyVaultSecretReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
CredentialReference
| Name | Description | Value |
|---|---|---|
| referenceName | Reference credential name. | string (required) |
| type | Credential reference type. | 'CredentialReference' (required) |
CustomDataSourceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CustomDataSource' (required) |
| typeProperties | Custom linked service properties. | any (required) |
DataworldLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dataworld' (required) |
| typeProperties | Dataworld linked service properties. | DataworldLinkedServiceTypeProperties (required) |
DataworldLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Dataworld source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
Db2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Db2' (required) |
| typeProperties | DB2 linked service properties. | Db2LinkedServiceTypeProperties (required) |
Db2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. | 'Basic' |
| certificateCommonName | Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| connectionString | The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. | string |
| packageCollection | Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
DrillLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Drill' (required) |
| typeProperties | Drill server linked service properties. | DrillLinkedServiceTypeProperties (required) |
DrillLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
DynamicsAXLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsAX' (required) |
| typeProperties | Dynamics AX linked service properties. | DynamicsAXLinkedServiceTypeProperties (required) |
DynamicsAXLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | 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). | SecretBase (required) |
| tenant | 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). | any (required) |
| url | The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint. | any (required) |
DynamicsCrmLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsCrm' (required) |
| typeProperties | Dynamics CRM linked service properties. | DynamicsCrmLinkedServiceTypeProperties (required) |
DynamicsCrmLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics CRM instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string). | any |
DynamicsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dynamics' (required) |
| typeProperties | Dynamics linked service properties. | DynamicsLinkedServiceTypeProperties (required) |
DynamicsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics instance. Type: string (or Expression with resultType string). | any |
EloquaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Eloqua' (required) |
| typeProperties | Eloqua server linked service properties. | EloquaLinkedServiceTypeProperties (required) |
EloquaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Eloqua server. (i.e. eloqua.example.com) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice) | any (required) |
FileServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FileServer' (required) |
| typeProperties | File system linked service properties. | FileServerLinkedServiceTypeProperties (required) |
FileServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the server. | SecretBase |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
FtpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FtpServer' (required) |
| typeProperties | Properties specific to this linked service type. | FtpServerLinkedServiceTypeProperties (required) |
FtpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Anonymous' 'Basic' |
| enableServerCertificateValidation | 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). | any |
| enableSsl | If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the FTP server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the FTP server. | SecretBase |
| port | 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. | any |
| userName | Username to logon the FTP server. Type: string (or Expression with resultType string). | any |
GoogleAdWordsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleAdWords' (required) |
| typeProperties | Google AdWords service linked service properties. | GoogleAdWordsLinkedServiceTypeProperties (required) |
GoogleAdWordsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' |
| clientCustomerID | The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). | any |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| connectionProperties | (Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| developerToken | The developer token associated with the manager account that you use to grant access to the AdWords API. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| googleAdsApiVersion | 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). | any |
| keyFilePath | (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). | any |
| loginCustomerID | 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). | any |
| privateKey | The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. | SecretBase |
| refreshToken | The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. | SecretBase |
| supportLegacyDataTypes | 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). | any |
| trustedCertPath | (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). | any |
| useSystemTrustStore | (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). | any |
GoogleBigQueryLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQuery' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryLinkedServiceTypeProperties (required) |
GoogleBigQueryLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalProjects | A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string). | any |
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFilePath | 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). | any |
| project | The default BigQuery project to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
| requestGoogleDriveScope | 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). | any |
| trustedCertPath | 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). | any |
| useSystemTrustStore | 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). | any |
GoogleBigQueryV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQueryV2' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryV2LinkedServiceTypeProperties (required) |
GoogleBigQueryV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFileContent | The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). | SecretBase |
| projectId | The default BigQuery project id to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
GoogleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleCloudStorage' (required) |
| typeProperties | Google Cloud Storage linked service properties. | GoogleCloudStorageLinkedServiceTypeProperties (required) |
GoogleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
GoogleSheetsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleSheets' (required) |
| typeProperties | GoogleSheets linked service properties. | GoogleSheetsLinkedServiceTypeProperties (required) |
GoogleSheetsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the GoogleSheets source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
GreenplumLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Greenplum' (required) |
| typeProperties | Greenplum Database linked service properties. | GreenplumLinkedServiceTypeProperties (required) |
GreenplumLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
HBaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HBase' (required) |
| typeProperties | HBase server linked service properties. | HBaseLinkedServiceTypeProperties (required) |
HBaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism to use to connect to the HBase server. | 'Anonymous' 'Basic' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the HBase server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the HBase instance uses to listen for client connections. The default value is 9090. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the HBase instance. | any |
HdfsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hdfs' (required) |
| typeProperties | HDFS linked service properties. | HdfsLinkedServiceTypeProperties (required) |
HdfsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Windows authentication. | SecretBase |
| url | The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Windows authentication. Type: string (or Expression with resultType string). | any |
HDInsightLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsight' (required) |
| typeProperties | HDInsight linked service properties. | HDInsightLinkedServiceTypeProperties (required) |
HDInsightLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clusterUri | HDInsight cluster URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileSystem | Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string). | any |
| hcatalogLinkedServiceName | A reference to the Azure SQL linked service that points to the HCatalog database. | LinkedServiceReference |
| isEspEnabled | Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean. | any |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference |
| password | HDInsight cluster password. | SecretBase |
| userName | HDInsight cluster user name. Type: string (or Expression with resultType string). | any |
HDInsightOnDemandLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsightOnDemand' (required) |
| typeProperties | HDInsight ondemand linked service properties. | HDInsightOnDemandLinkedServiceTypeProperties (required) |
HDInsightOnDemandLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalLinkedServiceNames | Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. | LinkedServiceReference[] |
| clusterNamePrefix | The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). | any |
| clusterPassword | The password to access the cluster. | SecretBase |
| clusterResourceGroup | The resource group where the cluster belongs. Type: string (or Expression with resultType string). | any (required) |
| clusterSize | Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). | any (required) |
| clusterSshPassword | The password to SSH remotely connect cluster’s node (for Linux). | SecretBase |
| clusterSshUserName | The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string). | any |
| clusterType | The cluster type. Type: string (or Expression with resultType string). | any |
| clusterUserName | The username to access the cluster. Type: string (or Expression with resultType string). | any |
| coreConfiguration | Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataNodeSize | Specifies the size of the data node for the HDInsight cluster. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hBaseConfiguration | Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. | any |
| hcatalogLinkedServiceName | 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. | LinkedServiceReference |
| hdfsConfiguration | Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. | any |
| headNodeSize | Specifies the size of the head node for the HDInsight cluster. | any |
| hiveConfiguration | Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. | any |
| hostSubscriptionId | The customer’s subscription to host the cluster. Type: string (or Expression with resultType string). | any (required) |
| linkedServiceName | Azure Storage linked service to be used by the on-demand cluster for storing and processing data. | LinkedServiceReference (required) |
| mapReduceConfiguration | Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. | any |
| oozieConfiguration | Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. | any |
| scriptActions | Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /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. | ScriptAction[] |
| servicePrincipalId | The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key for the service principal id. | SecretBase |
| sparkVersion | The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). | any |
| stormConfiguration | Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. | any |
| subnetName | 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). | any |
| tenant | The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
| timeToLive | 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). | any (required) |
| version | Version of the HDInsight cluster. Type: string (or Expression with resultType string). | any (required) |
| virtualNetworkId | The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string). | any |
| yarnConfiguration | Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. | any |
| zookeeperNodeSize | Specifies the size of the Zoo Keeper node for the HDInsight cluster. | any |
HiveLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hive' (required) |
| typeProperties | Hive Server linked service properties. | HiveLinkedServiceTypeProperties (required) |
HiveLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Hive server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). | any (required) |
| httpPath | The partial URL corresponding to the Hive server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Hive server uses to listen for client connections. | any |
| serverType | The type of Hive server. | 'HiveServer1' 'HiveServer2' 'HiveThriftServer' |
| serviceDiscoveryMode | true to indicate using the ZooKeeper service, false not. | any |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| useNativeQuery | Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL. | any |
| username | The user name that you use to access Hive Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
| zooKeeperNameSpace | The namespace on ZooKeeper under which Hive Server 2 nodes are added. | any |
HttpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HttpServer' (required) |
| typeProperties | Properties specific to this linked service type. | HttpLinkedServiceTypeProperties (required) |
HttpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the HTTP server. | 'Anonymous' 'Basic' 'ClientCertificate' 'Digest' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| certThumbprint | 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). | any |
| embeddedCertData | 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). | any |
| enableServerCertificateValidation | If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. | SecretBase |
| url | The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string). | any |
HubspotLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hubspot' (required) |
| typeProperties | Hubspot Service linked service properties. | HubspotLinkedServiceTypeProperties (required) |
HubspotLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token obtained when initially authenticating your OAuth integration. | SecretBase |
| clientId | The client ID associated with your Hubspot application. | any (required) |
| clientSecret | The client secret associated with your Hubspot application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| refreshToken | The refresh token obtained when initially authenticating your OAuth integration. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ImpalaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Impala' (required) |
| typeProperties | Impala server linked service properties. | ImpalaLinkedServiceTypeProperties (required) |
ImpalaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication type to use. | 'Anonymous' 'SASLUsername' 'UsernameAndPassword' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Impala server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name when using UsernameAndPassword. | SecretBase |
| port | The TCP port that the Impala server uses to listen for client connections. The default value is 21050. | any |
| trustedCertPath | 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. | any |
| username | The user name used to access the Impala server. The default value is anonymous when using SASLUsername. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
InformixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Informix' (required) |
| typeProperties | Informix linked service properties. | InformixLinkedServiceTypeProperties (required) |
InformixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
IntegrationRuntimeReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for integration runtime. | ParameterValueSpecification |
| referenceName | Reference integration runtime name. | string (required) |
| type | Type of integration runtime. | 'IntegrationRuntimeReference' (required) |
JiraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Jira' (required) |
| typeProperties | Jira Service linked service properties. | JiraLinkedServiceTypeProperties (required) |
JiraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Jira service. (e.g. jira.example.com) | any (required) |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| port | 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. | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Jira Service. | any (required) |
LakeHouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'LakeHouse' (required) |
| typeProperties | Microsoft Fabric LakeHouse linked service properties. | LakeHouseLinkedServiceTypeProperties (required) |
LakeHouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric LakeHouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
LinkedService
| Name | Description | Value |
|---|---|---|
| annotations | List of tags that can be used for describing the linked service. | any[] |
| connectVia | The integration runtime reference. | IntegrationRuntimeReference |
| description | Linked service description. | string |
| parameters | Parameters for linked service. | ParameterDefinitionSpecification |
| type | Set to 'AmazonMWS' for type AmazonMWSLinkedService. Set to 'AmazonRdsForOracle' for type AmazonRdsForOracleLinkedService. Set to 'AmazonRdsForSqlServer' for type AmazonRdsForSqlServerLinkedService. Set to 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AmazonS3Compatible' for type AmazonS3CompatibleLinkedService. Set to 'AppFigures' for type AppFiguresLinkedService. Set to 'Asana' for type AsanaLinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureBlobFS' for type AzureBlobFSLinkedService. Set to 'AzureBlobStorage' for type AzureBlobStorageLinkedService. Set to 'AzureDataExplorer' for type AzureDataExplorerLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureDatabricksDeltaLake' for type AzureDatabricksDeltaLakeLinkedService. Set to 'AzureFileStorage' for type AzureFileStorageLinkedService. Set to 'AzureFunction' for type AzureFunctionLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. Set to 'AzureMLService' for type AzureMLServiceLinkedService. Set to 'AzureMariaDB' for type AzureMariaDBLinkedService. Set to 'AzureMySql' for type AzureMySqlLinkedService. Set to 'AzurePostgreSql' for type AzurePostgreSqlLinkedService. Set to 'AzureSearch' for type AzureSearchLinkedService. Set to 'AzureSqlDW' for type AzureSqlDWLinkedService. Set to 'AzureSqlDatabase' for type AzureSqlDatabaseLinkedService. Set to 'AzureSqlMI' for type AzureSqlMILinkedService. Set to 'AzureStorage' for type AzureStorageLinkedService. Set to 'AzureSynapseArtifacts' for type AzureSynapseArtifactsLinkedService. Set to 'AzureTableStorage' for type AzureTableStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'CommonDataServiceForApps' for type CommonDataServiceForAppsLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'CosmosDbMongoDbApi' for type CosmosDbMongoDbApiLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Dataworld' for type DataworldLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'DynamicsAX' for type DynamicsAXLinkedService. Set to 'DynamicsCrm' for type DynamicsCrmLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleAdWords' for type GoogleAdWordsLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. Set to 'GoogleBigQueryV2' for type GoogleBigQueryV2LinkedService. Set to 'GoogleCloudStorage' for type GoogleCloudStorageLinkedService. Set to 'GoogleSheets' for type GoogleSheetsLinkedService. Set to 'Greenplum' for type GreenplumLinkedService. Set to 'HBase' for type HBaseLinkedService. Set to 'HDInsight' for type HDInsightLinkedService. Set to 'HDInsightOnDemand' for type HDInsightOnDemandLinkedService. Set to 'Hdfs' for type HdfsLinkedService. Set to 'Hive' for type HiveLinkedService. Set to 'HttpServer' for type HttpLinkedService. Set to 'Hubspot' for type HubspotLinkedService. Set to 'Impala' for type ImpalaLinkedService. Set to 'Informix' for type InformixLinkedService. Set to 'Jira' for type JiraLinkedService. Set to 'LakeHouse' for type LakeHouseLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MicrosoftAccess' for type MicrosoftAccessLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. Set to 'MongoDbAtlas' for type MongoDbAtlasLinkedService. Set to 'MongoDbV2' for type MongoDbV2LinkedService. Set to 'MySql' for type MySqlLinkedService. Set to 'Netezza' for type NetezzaLinkedService. Set to 'OData' for type ODataLinkedService. Set to 'Odbc' for type OdbcLinkedService. Set to 'Office365' for type Office365LinkedService. Set to 'Oracle' for type OracleLinkedService. Set to 'OracleCloudStorage' for type OracleCloudStorageLinkedService. Set to 'OracleServiceCloud' for type OracleServiceCloudLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'PostgreSqlV2' for type PostgreSqlV2LinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Quickbase' for type QuickbaseLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'RestService' for type RestServiceLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. Set to 'SalesforceServiceCloud' for type SalesforceServiceCloudLinkedService. Set to 'SalesforceServiceCloudV2' for type SalesforceServiceCloudV2LinkedService. Set to 'SalesforceV2' for type SalesforceV2LinkedService. Set to 'SapBW' for type SapBWLinkedService. Set to 'SapCloudForCustomer' for type SapCloudForCustomerLinkedService. Set to 'SapEcc' for type SapEccLinkedService. Set to 'SapHana' for type SapHanaLinkedService. Set to 'SapOdp' for type SapOdpLinkedService. Set to 'SapOpenHub' for type SapOpenHubLinkedService. Set to 'SapTable' for type SapTableLinkedService. Set to 'ServiceNow' for type ServiceNowLinkedService. Set to 'ServiceNowV2' for type ServiceNowV2LinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'SharePointOnlineList' for type SharePointOnlineListLinkedService. Set to 'Shopify' for type ShopifyLinkedService. Set to 'Smartsheet' for type SmartsheetLinkedService. Set to 'Snowflake' for type SnowflakeLinkedService. Set to 'SnowflakeV2' for type SnowflakeV2LinkedService. Set to 'Spark' for type SparkLinkedService. Set to 'SqlServer' for type SqlServerLinkedService. Set to 'Square' for type SquareLinkedService. Set to 'Sybase' for type SybaseLinkedService. Set to 'TeamDesk' for type TeamDeskLinkedService. Set to 'Teradata' for type TeradataLinkedService. Set to 'Twilio' for type TwilioLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Warehouse' for type WarehouseLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zendesk' for type ZendeskLinkedService. Set to 'Zoho' for type ZohoLinkedService. | 'AmazonMWS' 'AmazonRdsForOracle' 'AmazonRdsForSqlServer' 'AmazonRedshift' 'AmazonS3' 'AmazonS3Compatible' 'AppFigures' 'Asana' 'AzureBatch' 'AzureBlobFS' 'AzureBlobStorage' 'AzureDatabricks' 'AzureDatabricksDeltaLake' 'AzureDataExplorer' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureFileStorage' 'AzureFunction' 'AzureKeyVault' 'AzureMariaDB' 'AzureML' 'AzureMLService' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureSqlMI' 'AzureStorage' 'AzureSynapseArtifacts' 'AzureTableStorage' 'Cassandra' 'CommonDataServiceForApps' 'Concur' 'CosmosDb' 'CosmosDbMongoDbApi' 'Couchbase' 'CustomDataSource' 'Dataworld' 'Db2' 'Drill' 'Dynamics' 'DynamicsAX' 'DynamicsCrm' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleAdWords' 'GoogleBigQuery' 'GoogleBigQueryV2' 'GoogleCloudStorage' 'GoogleSheets' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Informix' 'Jira' 'LakeHouse' 'Magento' 'MariaDB' 'Marketo' 'MicrosoftAccess' 'MongoDb' 'MongoDbAtlas' 'MongoDbV2' 'MySql' 'Netezza' 'OData' 'Odbc' 'Office365' 'Oracle' 'OracleCloudStorage' 'OracleServiceCloud' 'Paypal' 'Phoenix' 'PostgreSql' 'PostgreSqlV2' 'Presto' 'Quickbase' 'QuickBooks' 'Responsys' 'RestService' 'Salesforce' 'SalesforceMarketingCloud' 'SalesforceServiceCloud' 'SalesforceServiceCloudV2' 'SalesforceV2' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'SapOdp' 'SapOpenHub' 'SapTable' 'ServiceNow' 'ServiceNowV2' 'Sftp' 'SharePointOnlineList' 'Shopify' 'Smartsheet' 'Snowflake' 'SnowflakeV2' 'Spark' 'SqlServer' 'Square' 'Sybase' 'TeamDesk' 'Teradata' 'Twilio' 'Vertica' 'Warehouse' 'Web' 'Xero' 'Zendesk' 'Zoho' (required) |
| version | Version of the linked service. | string |
LinkedServiceReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for LinkedService. | ParameterValueSpecification |
| referenceName | Reference LinkedService name. | string (required) |
| type | Linked service reference type. | 'LinkedServiceReference' (required) |
MagentoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Magento' (required) |
| typeProperties | Magento server linked service properties. | MagentoLinkedServiceTypeProperties (required) |
MagentoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token from Magento. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Magento instance. (i.e. 192.168.222.110/magento3) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
MariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MariaDB' (required) |
| typeProperties | MariaDB server linked service properties. | MariaDBLinkedServiceTypeProperties (required) |
MariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default) | any |
MarketoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Marketo' (required) |
| typeProperties | Marketo server linked service properties. | MarketoLinkedServiceTypeProperties (required) |
MarketoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client Id of your Marketo service. | any (required) |
| clientSecret | The client secret of your Marketo service. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
Microsoft.DataFactory/factories/linkedservices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-06-01' |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
| properties | Properties of linked service. | LinkedService (required) |
| type | The resource type | 'Microsoft.DataFactory/factories/linkedservices' |
MicrosoftAccessLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MicrosoftAccess' (required) |
| typeProperties | Microsoft Access linked service properties. | MicrosoftAccessLinkedServiceTypeProperties (required) |
MicrosoftAccessLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
MongoDbAtlasLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbAtlas' (required) |
| typeProperties | MongoDB Atlas linked service properties. | MongoDbAtlasLinkedServiceTypeProperties (required) |
MongoDbAtlasLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| driverVersion | The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string). | any |
MongoDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDb' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbLinkedServiceTypeProperties (required) |
MongoDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| authenticationType | The authentication type to be used to connect to the MongoDB database. | 'Anonymous' 'Basic' |
| authSource | Database to verify the username and password. Type: string (or Expression with resultType string). | any |
| databaseName | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| port | 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. | any |
| server | The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
MongoDbV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbV2' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbV2LinkedServiceTypeProperties (required) |
MongoDbV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
MySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MySql' (required) |
| typeProperties | MySQL linked service properties. | MySqlLinkedServiceTypeProperties (required) |
MySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowZeroDateTime | This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean. | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectionTimeout | The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer. | any |
| convertZeroDateTime | True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | 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. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| guidFormat | Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID. | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslCert | The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string. | any |
| sslKey | The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full. | any |
| treatTinyAsBoolean | When set to true, TINYINT(1) values are returned as booleans. Type: bool. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | Use system trust store for connection. Type: integer. 0: enable, 1: disable. | any |
NetezzaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Netezza' (required) |
| typeProperties | Netezza linked service properties. | NetezzaLinkedServiceTypeProperties (required) |
NetezzaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
ODataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OData' (required) |
| typeProperties | OData linked service properties. | ODataLinkedServiceTypeProperties (required) |
ODataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). | any |
| aadServicePrincipalCredentialType | Specify the credential type (key or cert) is used for service principal. | 'ServicePrincipalCert' 'ServicePrincipalKey' |
| authenticationType | Type of authentication used to connect to the OData service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| azureCloudType | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password of the OData service. | SecretBase |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| tenant | Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). | any |
| url | The URL of the OData service endpoint. Type: string (or Expression with resultType string). | any (required) |
| userName | User name of the OData service. Type: string (or Expression with resultType string). | any |
OdbcLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Odbc' (required) |
| typeProperties | ODBC linked service properties. | OdbcLinkedServiceTypeProperties (required) |
OdbcLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
Office365LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Office365' (required) |
| typeProperties | Office365 linked service properties. | Office365LinkedServiceTypeProperties (required) |
Office365LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| office365TenantId | Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | Specify the application's key. | SecretBase (required) |
| servicePrincipalTenantId | Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleCloudStorage' (required) |
| typeProperties | Oracle Cloud Storage linked service properties. | OracleCloudStorageLinkedServiceTypeProperties (required) |
OracleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
OracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Oracle' (required) |
| typeProperties | Oracle database linked service properties. | OracleLinkedServiceTypeProperties (required) |
OracleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
OracleServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleServiceCloud' (required) |
| typeProperties | Oracle Service Cloud linked service properties. | OracleServiceCloudLinkedServiceTypeProperties (required) |
OracleServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Oracle Service Cloud instance. | any (required) |
| password | The password corresponding to the user name that you provided in the username key. | SecretBase (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
| username | The user name that you use to access Oracle Service Cloud server. | any (required) |
ParameterDefinitionSpecification
| Name | Description | Value |
|---|
ParameterSpecification
| Name | Description | Value |
|---|---|---|
| defaultValue | Default value of parameter. | any |
| type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
| Name | Description | Value |
|---|
ParameterValueSpecification
| Name | Description | Value |
|---|
PaypalLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Paypal' (required) |
| typeProperties | Paypal Service linked service properties. | PaypalLinkedServiceTypeProperties (required) |
PaypalLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your PayPal application. | any (required) |
| clientSecret | The client secret associated with your PayPal application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
PhoenixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Phoenix' (required) |
| typeProperties | Phoenix server linked service properties. | PhoenixLinkedServiceTypeProperties (required) |
PhoenixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Phoenix server. | 'Anonymous' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Phoenix server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
PostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSql' (required) |
| typeProperties | PostgreSQL linked service properties. | PostgreSqlLinkedServiceTypeProperties (required) |
PostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
PostgreSqlV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSqlV2' (required) |
| typeProperties | PostgreSQLV2 linked service properties. | PostgreSqlV2LinkedServiceTypeProperties (required) |
PostgreSqlV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. Type: string. | any (required) |
| commandTimeout | 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. | any |
| connectionTimeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| database | Database name for connection. Type: string. | any (required) |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| logParameters | When enabled, parameter values are logged when commands are executed. Type: boolean. | any |
| password | The Azure key vault secret reference of password in connection string. Type: string. | AzureKeyVaultSecretReference |
| pooling | Whether connection pooling should be used. Type: boolean. | any |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| schema | Sets the schema search path. Type: string. | any |
| server | Server name for connection. Type: string. | any (required) |
| sslCertificate | Location of a client certificate to be sent to the server. Type: string. | any |
| sslKey | Location of a client key for a client certificate to be sent to the server. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any (required) |
| sslPassword | Password for a key for a client certificate. Type: string. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any (required) |
PrestoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Presto' (required) |
| typeProperties | Presto server linked service properties. | PrestoLinkedServiceTypeProperties (required) |
PrestoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Presto server. | 'Anonymous' 'LDAP' (required) |
| catalog | The catalog context for all request against the server. | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Presto server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Presto server uses to listen for client connections. The default value is 8080. | any |
| serverVersion | The version of the Presto server. (i.e. 0.148-t) | any (required) |
| timeZoneID | 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. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Presto server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
QuickbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Quickbase' (required) |
| typeProperties | Quickbase linked service properties. | QuickbaseLinkedServiceTypeProperties (required) |
QuickbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| url | The url to connect Quickbase source. Type: string (or Expression with resultType string). | any (required) |
| userToken | The user token for the Quickbase source. | SecretBase (required) |
QuickBooksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'QuickBooks' (required) |
| typeProperties | QuickBooks server linked service properties. | QuickBooksLinkedServiceTypeProperties (required) |
QuickBooksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for OAuth 1.0 authentication. | SecretBase |
| accessTokenSecret | The access token secret for OAuth 1.0 authentication. | SecretBase |
| companyId | The company ID of the QuickBooks company to authorize. | any |
| connectionProperties | Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key for OAuth 1.0 authentication. | any |
| consumerSecret | The consumer secret for OAuth 1.0 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
ResponsysLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Responsys' (required) |
| typeProperties | Responsys linked service properties. | ResponsysLinkedServiceTypeProperties (required) |
ResponsysLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Responsys application. Type: string (or Expression with resultType string). | any (required) |
| clientSecret | The client secret associated with the Responsys application. Type: string (or Expression with resultType string). | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Responsys server. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
RestServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'RestService' (required) |
| typeProperties | Rest Service linked service properties. | RestServiceLinkedServiceTypeProperties (required) |
RestServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | The resource you are requesting authorization to use. Type: string (or Expression with resultType string). | any |
| authenticationType | Type of authentication used to connect to the REST service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'OAuth2ClientCredential' (required) |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object). | any |
| azureCloudType | 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). | any |
| clientId | The client ID associated with your application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with your application. | SecretBase |
| credential | The credential reference containing authentication information. | CredentialReference |
| enableServerCertificateValidation | Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password used in Basic authentication type. | SecretBase |
| resource | The target service or resource to which the access will be requested. Type: string (or Expression with resultType string). | any |
| scope | The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string). | any |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The application's key used in AadServicePrincipal authentication type. | SecretBase |
| tenant | 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). | any |
| tokenEndpoint | The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string). | any |
| url | The base URL of the REST service. Type: string (or Expression with resultType string). | any (required) |
| userName | The user name used in Basic authentication type. Type: string (or Expression with resultType string). | any |
SalesforceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Salesforce' (required) |
| typeProperties | Salesforce linked service properties. | SalesforceLinkedServiceTypeProperties (required) |
SalesforceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceMarketingCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceMarketingCloud' (required) |
| typeProperties | Salesforce Marketing Cloud linked service properties. | SalesforceMarketingCloudLinkedServiceTypeProperties (required) |
SalesforceMarketingCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | SecretBase |
| connectionProperties | Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
SalesforceServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloud' (required) |
| typeProperties | Salesforce Service Cloud linked service properties. | SalesforceServiceCloudLinkedServiceTypeProperties (required) |
SalesforceServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| extendedProperties | Extended properties appended to the connection string. Type: string (or Expression with resultType string). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceServiceCloudV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloudV2' (required) |
| typeProperties | Salesforce Service Cloud V2 linked service properties. | SalesforceServiceCloudV2LinkedServiceTypeProperties (required) |
SalesforceServiceCloudV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SalesforceV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceV2' (required) |
| typeProperties | Salesforce V2 linked service properties. | SalesforceV2LinkedServiceTypeProperties (required) |
SalesforceV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SapBWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapBW' (required) |
| typeProperties | Properties specific to this linked service type. | SapBWLinkedServiceTypeProperties (required) |
SapBWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP BW server. | SecretBase |
| server | Host name of the SAP BW instance. Type: string (or Expression with resultType string). | any (required) |
| systemNumber | System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). | any (required) |
| userName | Username to access the SAP BW server. Type: string (or Expression with resultType string). | any |
SapCloudForCustomerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapCloudForCustomer' (required) |
| typeProperties | SAP Cloud for Customer linked service properties. | SapCloudForCustomerLinkedServiceTypeProperties (required) |
SapCloudForCustomerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | 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). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapEccLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapEcc' (required) |
| typeProperties | SAP ECC linked service properties. | SapEccLinkedServiceTypeProperties (required) |
SapEccLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapHanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapHana' (required) |
| typeProperties | Properties specific to this linked service type. | SapHanaLinkedServiceProperties (required) |
SapHanaLinkedServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the SAP HANA server. | 'Basic' 'Windows' |
| connectionString | SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP HANA server. | SecretBase |
| server | Host name of the SAP HANA server. Type: string (or Expression with resultType string). | any |
| userName | Username to access the SAP HANA server. Type: string (or Expression with resultType string). | any |
SapOdpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOdp' (required) |
| typeProperties | Properties specific to SAP ODP linked service type. | SapOdpLinkedServiceTypeProperties (required) |
SapOdpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| subscriberName | The subscriber name. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| x509CertificatePath | SNC X509 certificate file path. Type: string (or Expression with resultType string). | any |
SapOpenHubLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOpenHub' (required) |
| typeProperties | Properties specific to SAP Business Warehouse Open Hub Destination linked service type. | SapOpenHubLinkedServiceTypeProperties (required) |
SapOpenHubLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP BW server where the open hub destination is located. | SecretBase |
| server | Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string). | any |
SapTableLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapTable' (required) |
| typeProperties | Properties specific to this linked service type. | SapTableLinkedServiceTypeProperties (required) |
SapTableLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
ScriptAction
| Name | Description | Value |
|---|---|---|
| name | The user provided name of the script action. | string (required) |
| parameters | The parameters for the script action. | string |
| roles | The node types on which the script action should be executed. | any (required) |
| uri | The URI for the script action. | string (required) |
SecretBase
| Name | Description | Value |
|---|---|---|
| type | Set to 'AzureKeyVaultSecret' for type AzureKeyVaultSecretReference. Set to 'SecureString' for type SecureString. | 'AzureKeyVaultSecret' 'SecureString' (required) |
SecureString
| Name | Description | Value |
|---|---|---|
| type | Type of the secret. | 'SecureString' (required) |
| value | Value of secure string. | string (required) |
ServiceNowLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNow' (required) |
| typeProperties | ServiceNow server linked service properties. | ServiceNowLinkedServiceTypeProperties (required) |
ServiceNowLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com) | any (required) |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. | any |
ServiceNowV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNowV2' (required) |
| typeProperties | ServiceNowV2 server linked service properties. | ServiceNowV2LinkedServiceTypeProperties (required) |
ServiceNowV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNowV2 server. (i.e. <instance>.service-now.com) | any (required) |
| grantType | GrantType for OAuth2 authentication. Default value is password. | any |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| username | The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication. | any |
SftpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sftp' (required) |
| typeProperties | Properties specific to this linked service type. | SftpServerLinkedServiceTypeProperties (required) |
SftpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Basic' 'MultiFactor' 'SshPublicKey' |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The SFTP server host name. Type: string (or Expression with resultType string). | any (required) |
| hostKeyFingerprint | The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). | any |
| passPhrase | The password to decrypt the SSH private key if the SSH private key is encrypted. | SecretBase |
| password | Password to logon the SFTP server for Basic authentication. | SecretBase |
| port | 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. | any |
| privateKeyContent | 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. | SecretBase |
| privateKeyPath | 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). | any |
| skipHostKeyValidation | If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| userName | The username used to log on to the SFTP server. Type: string (or Expression with resultType string). | any |
SharePointOnlineListLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SharePointOnlineList' (required) |
| typeProperties | SharePoint Online List linked service properties. | SharePointOnlineListLinkedServiceTypeProperties (required) |
SharePointOnlineListLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | 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). | any (required) |
| servicePrincipalKey | The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| siteUrl | The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string). | any (required) |
| tenantId | 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). | any (required) |
ShopifyLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Shopify' (required) |
| typeProperties | Shopify Service linked service properties. | ShopifyLinkedServiceTypeProperties (required) |
ShopifyLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Shopify server. (i.e. mystore.myshopify.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SmartsheetLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Smartsheet' (required) |
| typeProperties | Smartsheet linked service properties. | SmartsheetLinkedServiceTypeProperties (required) |
SmartsheetLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Smartsheet source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
SnowflakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Snowflake' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedServiceTypeProperties (required) |
SnowflakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string of snowflake. Type: string, SecureString. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
SnowflakeLinkedV2ServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountIdentifier | The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure | any (required) |
| authenticationType | The type used for authentication. Type: string. | 'AADServicePrincipal' 'Basic' 'KeyPair' |
| clientId | The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| clientSecret | The Azure key vault secret reference of client secret for AADServicePrincipal authentication. | SecretBase |
| database | The name of the Snowflake database. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The host name of the Snowflake account. | any |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
| privateKey | The Azure key vault secret reference of privateKey for KeyPair auth. | SecretBase |
| privateKeyPassphrase | The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. | SecretBase |
| scope | The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| tenantId | The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| user | The name of the Snowflake user. | any |
| warehouse | The name of the Snowflake warehouse. | any (required) |
SnowflakeV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SnowflakeV2' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedV2ServiceTypeProperties (required) |
SparkLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Spark' (required) |
| typeProperties | Spark Server linked service properties. | SparkLinkedServiceTypeProperties (required) |
SparkLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Spark server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Spark server | any (required) |
| httpPath | The partial URL corresponding to the Spark server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Spark server uses to listen for client connections. | any (required) |
| serverType | The type of Spark server. | 'SharkServer' 'SharkServer2' 'SparkThriftServer' |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| username | The user name that you use to access Spark Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
SqlAlwaysEncryptedProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedAkvAuthType | Sql always encrypted AKV authentication type. Type: string. | 'ManagedIdentity' 'ServicePrincipal' 'UserAssignedManagedIdentity' (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure Key Vault. | SecretBase |
SqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SqlServer' (required) |
| typeProperties | SQL Server linked service properties. | SqlServerLinkedServiceTypeProperties (required) |
SqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'UserAssignedManagedIdentity' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
SquareLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Square' (required) |
| typeProperties | Square Service linked service properties. | SquareLinkedServiceTypeProperties (required) |
SquareLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your Square application. | any |
| clientSecret | The client secret associated with your Square application. | SecretBase |
| connectionProperties | Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Square instance. (i.e. mystore.mysquare.com) | any |
| redirectUri | The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SybaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sybase' (required) |
| typeProperties | Sybase linked service properties. | SybaseLinkedServiceTypeProperties (required) |
SybaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| schema | Schema name for connection. Type: string (or Expression with resultType string). | any |
| server | Server name for connection. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TeamDeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'TeamDesk' (required) |
| typeProperties | TeamDesk linked service properties. | TeamDeskLinkedServiceTypeProperties (required) |
TeamDeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the TeamDesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the TeamDesk source. | SecretBase |
| url | The url to connect TeamDesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the TeamDesk source. Type: string (or Expression with resultType string). | any |
TeradataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Teradata' (required) |
| typeProperties | Teradata linked service properties. | TeradataLinkedServiceTypeProperties (required) |
TeradataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| connectionString | Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TwilioLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Twilio' (required) |
| typeProperties | Twilio linked service properties. | TwilioLinkedServiceTypeProperties (required) |
TwilioLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| password | The auth token of Twilio service. | SecretBase (required) |
| userName | The Account SID of Twilio service. Type: string (or Expression with resultType string). | any (required) |
VerticaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Vertica' (required) |
| typeProperties | Vertica linked service properties. | VerticaLinkedServiceTypeProperties (required) |
VerticaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| port | The port for the connection. Type: integer. | any |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| server | Server name for connection. Type: string. | any |
| uid | Username for authentication. Type: string. | any |
WarehouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Warehouse' (required) |
| typeProperties | Microsoft Fabric Warehouse linked service properties. | WarehouseLinkedServiceTypeProperties (required) |
WarehouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
WebAnonymousAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Anonymous' (required) |
WebBasicAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Basic' (required) |
| password | The password for Basic authentication. | SecretBase (required) |
| username | User name for Basic authentication. Type: string (or Expression with resultType string). | any (required) |
WebClientCertificateAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'ClientCertificate' (required) |
| password | Password for the PFX file. | SecretBase (required) |
| pfx | Base64-encoded contents of a PFX file. | SecretBase (required) |
WebLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Web' (required) |
| typeProperties | Web linked service properties. | WebLinkedServiceTypeProperties (required) |
WebLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Set to 'Anonymous' for type WebAnonymousAuthentication. Set to 'Basic' for type WebBasicAuthentication. Set to 'ClientCertificate' for type WebClientCertificateAuthentication. | 'Anonymous' 'Basic' 'ClientCertificate' (required) |
| url | The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). | any (required) |
XeroLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Xero' (required) |
| typeProperties | Xero Service linked service properties. | XeroLinkedServiceTypeProperties (required) |
XeroLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionProperties | Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key associated with the Xero application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Xero server. (i.e. api.xero.com) | any |
| privateKey | 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( ). |
SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ZendeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zendesk' (required) |
| typeProperties | Zendesk linked service properties. | ZendeskLinkedServiceTypeProperties (required) |
ZendeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Zendesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Zendesk source. | SecretBase |
| url | The url to connect Zendesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the Zendesk source. Type: string (or Expression with resultType string). | any |
ZohoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zoho' (required) |
| typeProperties | Zoho server linked service properties. | ZohoLinkedServiceTypeProperties (required) |
ZohoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for Zoho authentication. | SecretBase |
| connectionProperties | Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| More is possible with Azure Data Factory - One click to try Azure Data Factory |
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
Terraform (AzAPI provider) resource definition
The factories/linkedservices resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories/linkedservices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataFactory/factories/linkedservices@2018-06-01"
name = "string"
body = jsonencode({
properties = {
annotations = [
?
]
connectVia = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
description = "string"
parameters = {
{customized property} = {
defaultValue = ?
type = "string"
}
}
version = "string"
type = "string"
// For remaining properties, see LinkedService objects
}
})
}
LinkedService objects
Set the type property to specify the type of object.
For AmazonMWS, use:
{
type = "AmazonMWS"
typeProperties = {
accessKeyId = ?
encryptedCredential = "string"
endpoint = ?
marketplaceID = ?
mwsAuthToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
secretKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
sellerID = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For AmazonRdsForOracle, use:
{
type = "AmazonRdsForOracle"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
}
For AmazonRdsForSqlServer, use:
{
type = "AmazonRdsForSqlServer"
typeProperties = {
alwaysEncryptedSettings = {
alwaysEncryptedAkvAuthType = "string"
credential = {
referenceName = "string"
type = "string"
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
applicationIntent = ?
authenticationType = "string"
commandTimeout = ?
connectionString = ?
connectRetryCount = ?
connectRetryInterval = ?
connectTimeout = ?
database = ?
encrypt = ?
encryptedCredential = "string"
failoverPartner = ?
hostNameInCertificate = ?
integratedSecurity = ?
loadBalanceTimeout = ?
maxPoolSize = ?
minPoolSize = ?
multipleActiveResultSets = ?
multiSubnetFailover = ?
packetSize = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
pooling = ?
server = ?
trustServerCertificate = ?
userName = ?
}
}
For AmazonRedshift, use:
{
type = "AmazonRedshift"
typeProperties = {
database = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
server = ?
username = ?
}
}
For AmazonS3, use:
{
type = "AmazonS3"
typeProperties = {
accessKeyId = ?
authenticationType = ?
encryptedCredential = "string"
secretAccessKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
serviceUrl = ?
sessionToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
}
For AmazonS3Compatible, use:
{
type = "AmazonS3Compatible"
typeProperties = {
accessKeyId = ?
encryptedCredential = "string"
forcePathStyle = ?
secretAccessKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
serviceUrl = ?
}
}
For AppFigures, use:
{
type = "AppFigures"
typeProperties = {
clientKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For Asana, use:
{
type = "Asana"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
}
}
For AzureBatch, use:
{
type = "AzureBatch"
typeProperties = {
accessKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
accountName = ?
batchUri = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
poolName = ?
}
}
For AzureBlobFS, use:
{
type = "AzureBlobFS"
typeProperties = {
accountKey = ?
azureCloudType = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
sasToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
sasUri = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
url = ?
}
}
For AzureBlobStorage, use:
{
type = "AzureBlobStorage"
typeProperties = {
accountKey = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
accountKind = ?
authenticationType = "string"
azureCloudType = ?
connectionString = ?
containerUri = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
sasToken = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
sasUri = ?
serviceEndpoint = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
}
}
For AzureDataExplorer, use:
{
type = "AzureDataExplorer"
typeProperties = {
credential = {
referenceName = "string"
type = "string"
}
database = ?
endpoint = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
}
}
For AzureDataLakeAnalytics, use:
{
type = "AzureDataLakeAnalytics"
typeProperties = {
accountName = ?
dataLakeAnalyticsUri = ?
encryptedCredential = "string"
resourceGroupName = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
subscriptionId = ?
tenant = ?
}
}
For AzureDataLakeStore, use:
{
type = "AzureDataLakeStore"
typeProperties = {
accountName = ?
azureCloudType = ?
credential = {
referenceName = "string"
type = "string"
}
dataLakeStoreUri = ?
encryptedCredential = "string"
resourceGroupName = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
subscriptionId = ?
tenant = ?
}
}
For AzureDatabricks, use:
{
type = "AzureDatabricks"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
authentication = ?
credential = {
referenceName = "string"
type = "string"
}
domain = ?
encryptedCredential = "string"
existingClusterId = ?
instancePoolId = ?
newClusterCustomTags = {
{customized property} = ?
}
newClusterDriverNodeType = ?
newClusterEnableElasticDisk = ?
newClusterInitScripts = ?
newClusterLogDestination = ?
newClusterNodeType = ?
newClusterNumOfWorker = ?
newClusterSparkConf = {
{customized property} = ?
}
newClusterSparkEnvVars = {
{customized property} = ?
}
newClusterVersion = ?
policyId = ?
workspaceResourceId = ?
}
}
For AzureDatabricksDeltaLake, use:
{
type = "AzureDatabricksDeltaLake"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
clusterId = ?
credential = {
referenceName = "string"
type = "string"
}
domain = ?
encryptedCredential = "string"
workspaceResourceId = ?
}
}
For AzureFileStorage, use:
{
type = "AzureFileStorage"
typeProperties = {
accountKey = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
connectionString = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
fileShare = ?
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
sasToken = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
sasUri = ?
serviceEndpoint = ?
snapshot = ?
userId = ?
}
}
For AzureFunction, use:
{
type = "AzureFunction"
typeProperties = {
authentication = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
functionAppUrl = ?
functionKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
resourceId = ?
}
}
For AzureKeyVault, use:
{
type = "AzureKeyVault"
typeProperties = {
baseUrl = ?
credential = {
referenceName = "string"
type = "string"
}
}
}
For AzureML, use:
{
type = "AzureML"
typeProperties = {
apiKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
authentication = ?
encryptedCredential = "string"
mlEndpoint = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
updateResourceEndpoint = ?
}
}
For AzureMLService, use:
{
type = "AzureMLService"
typeProperties = {
authentication = ?
encryptedCredential = "string"
mlWorkspaceName = ?
resourceGroupName = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
subscriptionId = ?
tenant = ?
}
}
For AzureMariaDB, use:
{
type = "AzureMariaDB"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
pwd = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For AzureMySql, use:
{
type = "AzureMySql"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For AzurePostgreSql, use:
{
type = "AzurePostgreSql"
typeProperties = {
commandTimeout = ?
connectionString = ?
database = ?
encoding = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
port = ?
readBufferSize = ?
server = ?
sslMode = ?
timeout = ?
timezone = ?
trustServerCertificate = ?
username = ?
}
}
For AzureSearch, use:
{
type = "AzureSearch"
typeProperties = {
encryptedCredential = "string"
key = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
}
}
For AzureSqlDW, use:
{
type = "AzureSqlDW"
typeProperties = {
applicationIntent = ?
authenticationType = "string"
azureCloudType = ?
commandTimeout = ?
connectionString = ?
connectRetryCount = ?
connectRetryInterval = ?
connectTimeout = ?
credential = {
referenceName = "string"
type = "string"
}
database = ?
encrypt = ?
encryptedCredential = "string"
failoverPartner = ?
hostNameInCertificate = ?
integratedSecurity = ?
loadBalanceTimeout = ?
maxPoolSize = ?
minPoolSize = ?
multipleActiveResultSets = ?
multiSubnetFailover = ?
packetSize = ?
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
pooling = ?
server = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
trustServerCertificate = ?
userName = ?
}
}
For AzureSqlDatabase, use:
{
type = "AzureSqlDatabase"
typeProperties = {
alwaysEncryptedSettings = {
alwaysEncryptedAkvAuthType = "string"
credential = {
referenceName = "string"
type = "string"
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
applicationIntent = ?
authenticationType = "string"
azureCloudType = ?
commandTimeout = ?
connectionString = ?
connectRetryCount = ?
connectRetryInterval = ?
connectTimeout = ?
credential = {
referenceName = "string"
type = "string"
}
database = ?
encrypt = ?
encryptedCredential = "string"
failoverPartner = ?
hostNameInCertificate = ?
integratedSecurity = ?
loadBalanceTimeout = ?
maxPoolSize = ?
minPoolSize = ?
multipleActiveResultSets = ?
multiSubnetFailover = ?
packetSize = ?
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
pooling = ?
server = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
trustServerCertificate = ?
userName = ?
}
}
For AzureSqlMI, use:
{
type = "AzureSqlMI"
typeProperties = {
alwaysEncryptedSettings = {
alwaysEncryptedAkvAuthType = "string"
credential = {
referenceName = "string"
type = "string"
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
applicationIntent = ?
authenticationType = "string"
azureCloudType = ?
commandTimeout = ?
connectionString = ?
connectRetryCount = ?
connectRetryInterval = ?
connectTimeout = ?
credential = {
referenceName = "string"
type = "string"
}
database = ?
encrypt = ?
encryptedCredential = "string"
failoverPartner = ?
hostNameInCertificate = ?
integratedSecurity = ?
loadBalanceTimeout = ?
maxPoolSize = ?
minPoolSize = ?
multipleActiveResultSets = ?
multiSubnetFailover = ?
packetSize = ?
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
pooling = ?
server = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
trustServerCertificate = ?
userName = ?
}
}
For AzureStorage, use:
{
type = "AzureStorage"
typeProperties = {
accountKey = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
connectionString = ?
encryptedCredential = "string"
sasToken = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
sasUri = ?
}
}
For AzureSynapseArtifacts, use:
{
type = "AzureSynapseArtifacts"
typeProperties = {
authentication = ?
endpoint = ?
workspaceResourceId = ?
}
}
For AzureTableStorage, use:
{
type = "AzureTableStorage"
typeProperties = {
accountKey = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
connectionString = ?
credential = {
referenceName = "string"
type = "string"
}
encryptedCredential = "string"
sasToken = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
sasUri = ?
serviceEndpoint = ?
}
}
For Cassandra, use:
{
type = "Cassandra"
typeProperties = {
authenticationType = ?
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
username = ?
}
}
For CommonDataServiceForApps, use:
{
type = "CommonDataServiceForApps"
typeProperties = {
authenticationType = ?
deploymentType = ?
domain = ?
encryptedCredential = "string"
hostName = ?
organizationName = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
serviceUri = ?
username = ?
}
}
For Concur, use:
{
type = "Concur"
typeProperties = {
clientId = ?
connectionProperties = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
username = ?
}
}
For CosmosDb, use:
{
type = "CosmosDb"
typeProperties = {
accountEndpoint = ?
accountKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
azureCloudType = ?
connectionMode = "string"
connectionString = ?
credential = {
referenceName = "string"
type = "string"
}
database = ?
encryptedCredential = "string"
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
tenant = ?
}
}
For CosmosDbMongoDbApi, use:
{
type = "CosmosDbMongoDbApi"
typeProperties = {
connectionString = ?
database = ?
isServerVersionAbove32 = ?
}
}
For Couchbase, use:
{
type = "Couchbase"
typeProperties = {
connectionString = ?
credString = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
encryptedCredential = "string"
}
}
For CustomDataSource, use:
{
type = "CustomDataSource"
typeProperties = ?
}
For Dataworld, use:
{
type = "Dataworld"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
}
}
For Db2, use:
{
type = "Db2"
typeProperties = {
authenticationType = "string"
certificateCommonName = ?
connectionString = ?
database = ?
encryptedCredential = "string"
packageCollection = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
username = ?
}
}
For Drill, use:
{
type = "Drill"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
pwd = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For Dynamics, use:
{
type = "Dynamics"
typeProperties = {
authenticationType = ?
credential = {
referenceName = "string"
type = "string"
}
deploymentType = ?
domain = ?
encryptedCredential = "string"
hostName = ?
organizationName = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
serviceUri = ?
username = ?
}
}
For DynamicsAX, use:
{
type = "DynamicsAX"
typeProperties = {
aadResourceId = ?
encryptedCredential = "string"
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
url = ?
}
}
For DynamicsCrm, use:
{
type = "DynamicsCrm"
typeProperties = {
authenticationType = ?
credential = {
referenceName = "string"
type = "string"
}
deploymentType = ?
domain = ?
encryptedCredential = "string"
hostName = ?
organizationName = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
serviceUri = ?
username = ?
}
}
For Eloqua, use:
{
type = "Eloqua"
typeProperties = {
encryptedCredential = "string"
endpoint = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
username = ?
}
}
For FileServer, use:
{
type = "FileServer"
typeProperties = {
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userId = ?
}
}
For FtpServer, use:
{
type = "FtpServer"
typeProperties = {
authenticationType = "string"
enableServerCertificateValidation = ?
enableSsl = ?
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
userName = ?
}
}
For GoogleAdWords, use:
{
type = "GoogleAdWords"
typeProperties = {
authenticationType = "string"
clientCustomerID = ?
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
connectionProperties = ?
developerToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
email = ?
encryptedCredential = "string"
googleAdsApiVersion = ?
keyFilePath = ?
loginCustomerID = ?
privateKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
refreshToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
supportLegacyDataTypes = ?
trustedCertPath = ?
useSystemTrustStore = ?
}
}
For GoogleBigQuery, use:
{
type = "GoogleBigQuery"
typeProperties = {
additionalProjects = ?
authenticationType = "string"
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
email = ?
encryptedCredential = "string"
keyFilePath = ?
project = ?
refreshToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
requestGoogleDriveScope = ?
trustedCertPath = ?
useSystemTrustStore = ?
}
}
For GoogleBigQueryV2, use:
{
type = "GoogleBigQueryV2"
typeProperties = {
authenticationType = "string"
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
keyFileContent = {
type = "string"
// For remaining properties, see SecretBase objects
}
projectId = ?
refreshToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
}
For GoogleCloudStorage, use:
{
type = "GoogleCloudStorage"
typeProperties = {
accessKeyId = ?
encryptedCredential = "string"
secretAccessKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
serviceUrl = ?
}
}
For GoogleSheets, use:
{
type = "GoogleSheets"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
}
}
For Greenplum, use:
{
type = "Greenplum"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
pwd = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For HBase, use:
{
type = "HBase"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
enableSsl = ?
encryptedCredential = "string"
host = ?
httpPath = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
trustedCertPath = ?
username = ?
}
}
For HDInsight, use:
{
type = "HDInsight"
typeProperties = {
clusterUri = ?
encryptedCredential = "string"
fileSystem = ?
hcatalogLinkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
isEspEnabled = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For HDInsightOnDemand, use:
{
type = "HDInsightOnDemand"
typeProperties = {
additionalLinkedServiceNames = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
clusterNamePrefix = ?
clusterPassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
clusterResourceGroup = ?
clusterSize = ?
clusterSshPassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
clusterSshUserName = ?
clusterType = ?
clusterUserName = ?
coreConfiguration = ?
credential = {
referenceName = "string"
type = "string"
}
dataNodeSize = ?
encryptedCredential = "string"
hBaseConfiguration = ?
hcatalogLinkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
hdfsConfiguration = ?
headNodeSize = ?
hiveConfiguration = ?
hostSubscriptionId = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
mapReduceConfiguration = ?
oozieConfiguration = ?
scriptActions = [
{
name = "string"
parameters = "string"
roles = ?
uri = "string"
}
]
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
sparkVersion = ?
stormConfiguration = ?
subnetName = ?
tenant = ?
timeToLive = ?
version = ?
virtualNetworkId = ?
yarnConfiguration = ?
zookeeperNodeSize = ?
}
}
For Hdfs, use:
{
type = "Hdfs"
typeProperties = {
authenticationType = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
userName = ?
}
}
For Hive, use:
{
type = "Hive"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
enableSsl = ?
encryptedCredential = "string"
host = ?
httpPath = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
serverType = "string"
serviceDiscoveryMode = ?
thriftTransportProtocol = "string"
trustedCertPath = ?
useNativeQuery = ?
username = ?
useSystemTrustStore = ?
zooKeeperNameSpace = ?
}
}
For HttpServer, use:
{
type = "HttpServer"
typeProperties = {
authenticationType = "string"
authHeaders = ?
certThumbprint = ?
embeddedCertData = ?
enableServerCertificateValidation = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
userName = ?
}
}
For Hubspot, use:
{
type = "Hubspot"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
refreshToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For Impala, use:
{
type = "Impala"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
enableSsl = ?
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
trustedCertPath = ?
username = ?
useSystemTrustStore = ?
}
}
For Informix, use:
{
type = "Informix"
typeProperties = {
authenticationType = ?
connectionString = ?
credential = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For Jira, use:
{
type = "Jira"
typeProperties = {
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
username = ?
}
}
For LakeHouse, use:
{
type = "LakeHouse"
typeProperties = {
artifactId = ?
encryptedCredential = "string"
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
workspaceId = ?
}
}
For Magento, use:
{
type = "Magento"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
host = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For MariaDB, use:
{
type = "MariaDB"
typeProperties = {
connectionString = ?
database = ?
driverVersion = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
port = ?
server = ?
sslMode = ?
username = ?
useSystemTrustStore = ?
}
}
For Marketo, use:
{
type = "Marketo"
typeProperties = {
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
endpoint = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For MicrosoftAccess, use:
{
type = "MicrosoftAccess"
typeProperties = {
authenticationType = ?
connectionString = ?
credential = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For MongoDb, use:
{
type = "MongoDb"
typeProperties = {
allowSelfSignedServerCert = ?
authenticationType = "string"
authSource = ?
databaseName = ?
enableSsl = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
server = ?
username = ?
}
}
For MongoDbAtlas, use:
{
type = "MongoDbAtlas"
typeProperties = {
connectionString = ?
database = ?
driverVersion = ?
}
}
For MongoDbV2, use:
{
type = "MongoDbV2"
typeProperties = {
connectionString = ?
database = ?
}
}
For MySql, use:
{
type = "MySql"
typeProperties = {
allowZeroDateTime = ?
connectionString = ?
connectionTimeout = ?
convertZeroDateTime = ?
database = ?
driverVersion = ?
encryptedCredential = "string"
guidFormat = ?
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
port = ?
server = ?
sslCert = ?
sslKey = ?
sslMode = ?
treatTinyAsBoolean = ?
username = ?
useSystemTrustStore = ?
}
}
For Netezza, use:
{
type = "Netezza"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
pwd = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For OData, use:
{
type = "OData"
typeProperties = {
aadResourceId = ?
aadServicePrincipalCredentialType = "string"
authenticationType = "string"
authHeaders = ?
azureCloudType = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCert = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
url = ?
userName = ?
}
}
For Odbc, use:
{
type = "Odbc"
typeProperties = {
authenticationType = ?
connectionString = ?
credential = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For Office365, use:
{
type = "Office365"
typeProperties = {
encryptedCredential = "string"
office365TenantId = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalTenantId = ?
}
}
For Oracle, use:
{
type = "Oracle"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For OracleCloudStorage, use:
{
type = "OracleCloudStorage"
typeProperties = {
accessKeyId = ?
encryptedCredential = "string"
secretAccessKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
serviceUrl = ?
}
}
For OracleServiceCloud, use:
{
type = "OracleServiceCloud"
typeProperties = {
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
username = ?
}
}
For Paypal, use:
{
type = "Paypal"
typeProperties = {
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
host = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For Phoenix, use:
{
type = "Phoenix"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
enableSsl = ?
encryptedCredential = "string"
host = ?
httpPath = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
trustedCertPath = ?
username = ?
useSystemTrustStore = ?
}
}
For PostgreSql, use:
{
type = "PostgreSql"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For PostgreSqlV2, use:
{
type = "PostgreSqlV2"
typeProperties = {
authenticationType = ?
commandTimeout = ?
connectionTimeout = ?
database = ?
encoding = ?
encryptedCredential = "string"
logParameters = ?
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
pooling = ?
port = ?
readBufferSize = ?
schema = ?
server = ?
sslCertificate = ?
sslKey = ?
sslMode = ?
sslPassword = ?
timezone = ?
trustServerCertificate = ?
username = ?
}
}
For Presto, use:
{
type = "Presto"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
catalog = ?
enableSsl = ?
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
serverVersion = ?
timeZoneID = ?
trustedCertPath = ?
username = ?
useSystemTrustStore = ?
}
}
For QuickBooks, use:
{
type = "QuickBooks"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
accessTokenSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
companyId = ?
connectionProperties = ?
consumerKey = ?
consumerSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
endpoint = ?
useEncryptedEndpoints = ?
}
}
For Quickbase, use:
{
type = "Quickbase"
typeProperties = {
encryptedCredential = "string"
url = ?
userToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
}
For Responsys, use:
{
type = "Responsys"
typeProperties = {
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
endpoint = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For RestService, use:
{
type = "RestService"
typeProperties = {
aadResourceId = ?
authenticationType = "string"
authHeaders = ?
azureCloudType = ?
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
credential = {
referenceName = "string"
type = "string"
}
enableServerCertificateValidation = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
resource = ?
scope = ?
servicePrincipalCredentialType = ?
servicePrincipalEmbeddedCert = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
tokenEndpoint = ?
url = ?
userName = ?
}
}
For Salesforce, use:
{
type = "Salesforce"
typeProperties = {
apiVersion = ?
encryptedCredential = "string"
environmentUrl = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
securityToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
username = ?
}
}
For SalesforceMarketingCloud, use:
{
type = "SalesforceMarketingCloud"
typeProperties = {
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
connectionProperties = ?
encryptedCredential = "string"
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For SalesforceServiceCloud, use:
{
type = "SalesforceServiceCloud"
typeProperties = {
apiVersion = ?
encryptedCredential = "string"
environmentUrl = ?
extendedProperties = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
securityToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
username = ?
}
}
For SalesforceServiceCloudV2, use:
{
type = "SalesforceServiceCloudV2"
typeProperties = {
apiVersion = ?
authenticationType = ?
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
environmentUrl = ?
}
}
For SalesforceV2, use:
{
type = "SalesforceV2"
typeProperties = {
apiVersion = ?
authenticationType = ?
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
environmentUrl = ?
}
}
For SapBW, use:
{
type = "SapBW"
typeProperties = {
clientId = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
systemNumber = ?
userName = ?
}
}
For SapCloudForCustomer, use:
{
type = "SapCloudForCustomer"
typeProperties = {
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
username = ?
}
}
For SapEcc, use:
{
type = "SapEcc"
typeProperties = {
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
username = ?
}
}
For SapHana, use:
{
type = "SapHana"
typeProperties = {
authenticationType = "string"
connectionString = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
userName = ?
}
}
For SapOdp, use:
{
type = "SapOdp"
typeProperties = {
clientId = ?
encryptedCredential = "string"
language = ?
logonGroup = ?
messageServer = ?
messageServerService = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
sncLibraryPath = ?
sncMode = ?
sncMyName = ?
sncPartnerName = ?
sncQop = ?
subscriberName = ?
systemId = ?
systemNumber = ?
userName = ?
x509CertificatePath = ?
}
}
For SapOpenHub, use:
{
type = "SapOpenHub"
typeProperties = {
clientId = ?
encryptedCredential = "string"
language = ?
logonGroup = ?
messageServer = ?
messageServerService = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
systemId = ?
systemNumber = ?
userName = ?
}
}
For SapTable, use:
{
type = "SapTable"
typeProperties = {
clientId = ?
encryptedCredential = "string"
language = ?
logonGroup = ?
messageServer = ?
messageServerService = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
sncLibraryPath = ?
sncMode = ?
sncMyName = ?
sncPartnerName = ?
sncQop = ?
systemId = ?
systemNumber = ?
userName = ?
}
}
For ServiceNow, use:
{
type = "ServiceNow"
typeProperties = {
authenticationType = "string"
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
endpoint = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
username = ?
}
}
For ServiceNowV2, use:
{
type = "ServiceNowV2"
typeProperties = {
authenticationType = "string"
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
endpoint = ?
grantType = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
username = ?
}
}
For Sftp, use:
{
type = "Sftp"
typeProperties = {
authenticationType = "string"
encryptedCredential = "string"
host = ?
hostKeyFingerprint = ?
passPhrase = {
type = "string"
// For remaining properties, see SecretBase objects
}
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
privateKeyContent = {
type = "string"
// For remaining properties, see SecretBase objects
}
privateKeyPath = ?
skipHostKeyValidation = ?
userName = ?
}
}
For SharePointOnlineList, use:
{
type = "SharePointOnlineList"
typeProperties = {
encryptedCredential = "string"
servicePrincipalCredentialType = ?
servicePrincipalEmbeddedCert = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalEmbeddedCertPassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
siteUrl = ?
tenantId = ?
}
}
For Shopify, use:
{
type = "Shopify"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
host = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For Smartsheet, use:
{
type = "Smartsheet"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
}
}
For Snowflake, use:
{
type = "Snowflake"
typeProperties = {
connectionString = ?
encryptedCredential = "string"
password = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
}
}
For SnowflakeV2, use:
{
type = "SnowflakeV2"
typeProperties = {
accountIdentifier = ?
authenticationType = "string"
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
database = ?
encryptedCredential = "string"
host = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
privateKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
privateKeyPassphrase = {
type = "string"
// For remaining properties, see SecretBase objects
}
scope = ?
tenantId = ?
user = ?
warehouse = ?
}
}
For Spark, use:
{
type = "Spark"
typeProperties = {
allowHostNameCNMismatch = ?
allowSelfSignedServerCert = ?
authenticationType = "string"
enableSsl = ?
encryptedCredential = "string"
host = ?
httpPath = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
port = ?
serverType = "string"
thriftTransportProtocol = "string"
trustedCertPath = ?
username = ?
useSystemTrustStore = ?
}
}
For SqlServer, use:
{
type = "SqlServer"
typeProperties = {
alwaysEncryptedSettings = {
alwaysEncryptedAkvAuthType = "string"
credential = {
referenceName = "string"
type = "string"
}
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
applicationIntent = ?
authenticationType = "string"
commandTimeout = ?
connectionString = ?
connectRetryCount = ?
connectRetryInterval = ?
connectTimeout = ?
credential = {
referenceName = "string"
type = "string"
}
database = ?
encrypt = ?
encryptedCredential = "string"
failoverPartner = ?
hostNameInCertificate = ?
integratedSecurity = ?
loadBalanceTimeout = ?
maxPoolSize = ?
minPoolSize = ?
multipleActiveResultSets = ?
multiSubnetFailover = ?
packetSize = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
pooling = ?
server = ?
trustServerCertificate = ?
userName = ?
}
}
For Square, use:
{
type = "Square"
typeProperties = {
clientId = ?
clientSecret = {
type = "string"
// For remaining properties, see SecretBase objects
}
connectionProperties = ?
encryptedCredential = "string"
host = ?
redirectUri = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For Sybase, use:
{
type = "Sybase"
typeProperties = {
authenticationType = "string"
database = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
schema = ?
server = ?
username = ?
}
}
For TeamDesk, use:
{
type = "TeamDesk"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
authenticationType = "string"
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
userName = ?
}
}
For Teradata, use:
{
type = "Teradata"
typeProperties = {
authenticationType = "string"
connectionString = ?
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
server = ?
username = ?
}
}
For Twilio, use:
{
type = "Twilio"
typeProperties = {
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
}
For Vertica, use:
{
type = "Vertica"
typeProperties = {
connectionString = ?
database = ?
encryptedCredential = "string"
port = ?
pwd = {
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "string"
}
server = ?
uid = ?
}
}
For Warehouse, use:
{
type = "Warehouse"
typeProperties = {
artifactId = ?
encryptedCredential = "string"
endpoint = ?
servicePrincipalCredential = {
type = "string"
// For remaining properties, see SecretBase objects
}
servicePrincipalCredentialType = ?
servicePrincipalId = ?
servicePrincipalKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
tenant = ?
workspaceId = ?
}
}
For Web, use:
{
type = "Web"
typeProperties = {
url = ?
authenticationType = "string"
// For remaining properties, see WebLinkedServiceTypeProperties objects
}
}
For Xero, use:
{
type = "Xero"
typeProperties = {
connectionProperties = ?
consumerKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
encryptedCredential = "string"
host = ?
privateKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
For Zendesk, use:
{
type = "Zendesk"
typeProperties = {
apiToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
authenticationType = "string"
encryptedCredential = "string"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
url = ?
userName = ?
}
}
For Zoho, use:
{
type = "Zoho"
typeProperties = {
accessToken = {
type = "string"
// For remaining properties, see SecretBase objects
}
connectionProperties = ?
encryptedCredential = "string"
endpoint = ?
useEncryptedEndpoints = ?
useHostVerification = ?
usePeerVerification = ?
}
}
SecretBase objects
Set the type property to specify the type of object.
For AzureKeyVaultSecret, use:
{
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "AzureKeyVaultSecret"
}
For SecureString, use:
{
type = "SecureString"
value = "string"
}
WebLinkedServiceTypeProperties objects
Set the authenticationType property to specify the type of object.
For Anonymous, use:
{
authenticationType = "Anonymous"
}
For Basic, use:
{
authenticationType = "Basic"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
username = ?
}
For ClientCertificate, use:
{
authenticationType = "ClientCertificate"
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
pfx = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
Property values
AmazonMWSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonMWS' (required) |
| typeProperties | Amazon Marketplace Web Service linked service properties. | AmazonMWSLinkedServiceTypeProperties (required) |
AmazonMWSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key id used to access data. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) | any (required) |
| marketplaceID | 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) | any (required) |
| mwsAuthToken | The Amazon MWS authentication token. | SecretBase |
| secretKey | The secret key used to access data. | SecretBase |
| sellerID | The Amazon seller ID. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
AmazonRdsForLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
AmazonRdsForOracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForOracle' (required) |
| typeProperties | AmazonRdsForOracle database linked service properties. | AmazonRdsForLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRdsForSqlServer' (required) |
| typeProperties | Amazon RDS for SQL Server linked service properties. | AmazonRdsForSqlServerLinkedServiceTypeProperties (required) |
AmazonRdsForSqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
AmazonRedshiftLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonRedshift' (required) |
| typeProperties | Amazon Redshift linked service properties. | AmazonRedshiftLinkedServiceTypeProperties (required) |
AmazonRedshiftLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| database | The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Amazon Redshift source. | SecretBase |
| port | 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). | any |
| server | The name of the Amazon Redshift server. Type: string (or Expression with resultType string). | any (required) |
| username | The username of the Amazon Redshift source. Type: string (or Expression with resultType string). | any |
AmazonS3CompatibleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3Compatible' (required) |
| typeProperties | Amazon S3 Compatible linked service properties. | AmazonS3CompatibleLinkedServiceTypeProperties (required) |
AmazonS3CompatibleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| forcePathStyle | If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| secretAccessKey | The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
AmazonS3LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AmazonS3' (required) |
| typeProperties | Amazon S3 linked service properties. | AmazonS3LinkedServiceTypeProperties (required) |
AmazonS3LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| authenticationType | The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Amazon S3 Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
| sessionToken | The session token for the S3 temporary security credential. | SecretBase |
AppFiguresLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AppFigures' (required) |
| typeProperties | AppFigures linked service properties. | AppFiguresLinkedServiceTypeProperties (required) |
AppFiguresLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientKey | The client key for the AppFigures source. | SecretBase (required) |
| password | The password of the AppFigures source. | SecretBase (required) |
| userName | The username of the Appfigures source. Type: string (or Expression with resultType string). | any (required) |
AsanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Asana' (required) |
| typeProperties | Asana linked service properties. | AsanaLinkedServiceTypeProperties (required) |
AsanaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Asana source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
AzureBatchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBatch' (required) |
| typeProperties | Azure Batch linked service properties. | AzureBatchLinkedServiceTypeProperties (required) |
AzureBatchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKey | The Azure Batch account access key. | SecretBase |
| accountName | The Azure Batch account name. Type: string (or Expression with resultType string). | any (required) |
| batchUri | The Azure Batch URI. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference (required) |
| poolName | The Azure Batch pool name. Type: string (or Expression with resultType string). | any (required) |
AzureBlobFSLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobFS' (required) |
| typeProperties | Azure Data Lake Storage Gen2 linked service properties. | AzureBlobFSLinkedServiceTypeProperties (required) |
AzureBlobFSLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | SecretBase |
| sasUri | SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| url | Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). | any |
AzureBlobStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureBlobStorage' (required) |
| typeProperties | Azure Blob Storage linked service properties. | AzureBlobStorageLinkedServiceTypeProperties (required) |
AzureBlobStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| accountKind | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'AccountKey' 'Anonymous' 'Msi' 'SasUri' 'ServicePrincipal' |
| azureCloudType | 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). | any |
| connectionString | The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| containerUri | Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDatabricksDeltaLakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricksDeltaLake' (required) |
| typeProperties | Azure Databricks Delta Lake linked service properties. | AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required) |
AzureDatabricksDetltaLakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. | SecretBase |
| clusterId | The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDatabricks' (required) |
| typeProperties | Azure Databricks linked service properties. | AzureDatabricksLinkedServiceTypeProperties (required) |
AzureDatabricksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string). | SecretBase |
| authentication | Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| domain | <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| existingClusterId | The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| instancePoolId | The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string). | any |
| newClusterCustomTags | Additional tags for cluster resources. This property is ignored in instance pool configurations. | AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags |
| newClusterDriverNodeType | The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string). | any |
| newClusterEnableElasticDisk | 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). | any |
| newClusterInitScripts | User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings). | any |
| newClusterLogDestination | Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string). | any |
| newClusterNodeType | 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). | any |
| newClusterNumOfWorker | 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). | any |
| newClusterSparkConf | A set of optional, user-specified Spark configuration key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf |
| newClusterSparkEnvVars | A set of optional, user-specified Spark environment variables key-value pairs. | AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars |
| newClusterVersion | 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). | any |
| policyId | 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). | any |
| workspaceResourceId | Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). | any |
AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
| Name | Description | Value |
|---|
AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars
| Name | Description | Value |
|---|
AzureDataExplorerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataExplorer' (required) |
| typeProperties | Azure Data Explorer (Kusto) linked service properties. | AzureDataExplorerLinkedServiceTypeProperties (required) |
AzureDataExplorerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| credential | The credential reference containing authentication information. | CredentialReference |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| endpoint | The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://<clusterName>.<regionName>.kusto.windows.net. Type: string (or Expression with resultType string) | any (required) |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Kusto. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureDataLakeAnalyticsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeAnalytics' (required) |
| typeProperties | Azure Data Lake Analytics linked service properties. | AzureDataLakeAnalyticsLinkedServiceTypeProperties (required) |
AzureDataLakeAnalyticsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string). | any (required) |
| dataLakeAnalyticsUri | Azure Data Lake Analytics URI Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Analytics account. | SecretBase |
| subscriptionId | Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
AzureDataLakeStoreLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureDataLakeStore' (required) |
| typeProperties | Azure Data Lake Store linked service properties. | AzureDataLakeStoreLinkedServiceTypeProperties (required) |
AzureDataLakeStoreLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountName | Data Lake Store account name. Type: string (or Expression with resultType string). | any |
| azureCloudType | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataLakeStoreUri | Data Lake Store service URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| resourceGroupName | Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| servicePrincipalId | The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against the Azure Data Lake Store account. | SecretBase |
| subscriptionId | Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureFileStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFileStorage' (required) |
| typeProperties | Azure File Storage linked service properties. | AzureFileStorageLinkedServiceTypeProperties (required) |
AzureFileStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileShare | The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string). | any |
| host | Host name of the server. Type: string (or Expression with resultType string). | any |
| password | Password to logon the server. | SecretBase |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
| snapshot | The azure file share snapshot version. Type: string (or Expression with resultType string). | any |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
AzureFunctionLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureFunction' (required) |
| typeProperties | Azure Function linked service properties. | AzureFunctionLinkedServiceTypeProperties (required) |
AzureFunctionLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| functionAppUrl | The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string). | any (required) |
| functionKey | Function or Host key for Azure Function App. | SecretBase |
| resourceId | Allowed token audiences for azure function. Type: string (or Expression with resultType string). | any |
AzureKeyVaultLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureKeyVault' (required) |
| typeProperties | Azure Key Vault linked service properties. | AzureKeyVaultLinkedServiceTypeProperties (required) |
AzureKeyVaultLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| baseUrl | The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | string (required) |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). | any (required) |
| secretVersion | 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). | any |
| store | The Azure Key Vault linked service reference. | LinkedServiceReference (required) |
| type | Type of the secret. | 'AzureKeyVaultSecret' (required) |
AzureMariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMariaDB' (required) |
| typeProperties | Azure Database for MariaDB linked service properties. | AzureMariaDBLinkedServiceTypeProperties (required) |
AzureMariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzureMLLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureML' (required) |
| typeProperties | Azure ML Studio Web Service linked service properties. | AzureMLLinkedServiceTypeProperties (required) |
AzureMLLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiKey | The API key for accessing the Azure ML model endpoint. | SecretBase (required) |
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlEndpoint | The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| updateResourceEndpoint | The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). | any |
AzureMLServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMLService' (required) |
| typeProperties | Azure ML Service linked service properties. | AzureMLServiceLinkedServiceTypeProperties (required) |
AzureMLServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| mlWorkspaceName | Azure ML Service workspace name. Type: string (or Expression with resultType string). | any (required) |
| resourceGroupName | Azure ML Service workspace resource group name. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | 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). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. | SecretBase |
| subscriptionId | Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string). | any (required) |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
AzureMySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureMySql' (required) |
| typeProperties | Azure MySQL database linked service properties. | AzureMySqlLinkedServiceTypeProperties (required) |
AzureMySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
AzurePostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzurePostgreSql' (required) |
| typeProperties | Azure PostgreSQL linked service properties. | AzurePostgreSqlLinkedServiceTypeProperties (required) |
AzurePostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| commandTimeout | 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. | any |
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any |
| timeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any |
AzureSearchLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSearch' (required) |
| typeProperties | Windows Azure Search Service linked service properties. | AzureSearchLinkedServiceTypeProperties (required) |
AzureSearchLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| key | Admin Key for Azure Search service | SecretBase |
| url | URL for Azure Search service. Type: string (or Expression with resultType string). | any (required) |
AzureSqlDatabaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDatabase' (required) |
| typeProperties | Azure SQL Database linked service properties. | AzureSqlDatabaseLinkedServiceTypeProperties (required) |
AzureSqlDatabaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Database. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlDWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlDW' (required) |
| typeProperties | Azure SQL Data Warehouse linked service properties. | AzureSqlDWLinkedServiceTypeProperties (required) |
AzureSqlDWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Data Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureSqlMILinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSqlMI' (required) |
| typeProperties | Azure SQL Managed Instance linked service properties. | AzureSqlMILinkedServiceTypeProperties (required) |
AzureSqlMILinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'ServicePrincipal' 'SQL' 'SystemAssignedManagedIdentity' 'UserAssignedManagedIdentity' |
| azureCloudType | 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). | any |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| pooling | 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). | any |
| server | 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). | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure SQL Managed Instance. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| trustServerCertificate | 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). | any |
| userName | The user name to be used when connecting to server. Type: string (or Expression with resultType string). | any |
AzureStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureStorage' (required) |
| typeProperties | Azure Storage linked service properties. | AzureStorageLinkedServiceTypeProperties (required) |
AzureStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
AzureSynapseArtifactsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureSynapseArtifacts' (required) |
| typeProperties | Azure Synapse Analytics (Artifacts) linked service properties. | AzureSynapseArtifactsLinkedServiceTypeProperties (required) |
AzureSynapseArtifactsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string). | any |
| endpoint | https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string). | any (required) |
| workspaceResourceId | 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). | any |
AzureTableStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'AzureTableStorage' (required) |
| typeProperties | Azure Table Storage linked service properties. | AzureTableStorageLinkedServiceTypeProperties (required) |
AzureTableStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountKey | The Azure key vault secret reference of accountKey in connection string. | AzureKeyVaultSecretReference |
| connectionString | The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| sasToken | The Azure key vault secret reference of sasToken in sas uri. | AzureKeyVaultSecretReference |
| sasUri | SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| serviceEndpoint | Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property. | any |
CassandraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Cassandra' (required) |
| typeProperties | Cassandra linked service properties. | CassandraLinkedServiceTypeProperties (required) |
CassandraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name for connection. Type: string (or Expression with resultType string). | any (required) |
| password | Password for authentication. | SecretBase |
| port | The port for the connection. Type: integer (or Expression with resultType integer). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
CommonDataServiceForAppsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CommonDataServiceForApps' (required) |
| typeProperties | Common Data Service for Apps linked service properties. | CommonDataServiceForAppsLinkedServiceTypeProperties (required) |
CommonDataServiceForAppsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Common Data Service for Apps instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). | any |
ConcurLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Concur' (required) |
| typeProperties | Concur Service linked service properties. | ConcurLinkedServiceTypeProperties (required) |
ConcurLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | Application client_id supplied by Concur App Management. | any (required) |
| connectionProperties | Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Concur Service. | any (required) |
CosmosDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDb' (required) |
| typeProperties | CosmosDB linked service properties. | CosmosDbLinkedServiceTypeProperties (required) |
CosmosDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountEndpoint | The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) | any |
| accountKey | The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. | SecretBase |
| azureCloudType | 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). | any |
| connectionMode | The connection mode used to access CosmosDB account. Type: string. | 'Direct' 'Gateway' |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database. Type: string (or Expression with resultType string) | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
CosmosDbMongoDbApiLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CosmosDbMongoDbApi' (required) |
| typeProperties | CosmosDB (MongoDB API) linked service properties. | CosmosDbMongoDbApiLinkedServiceTypeProperties (required) |
CosmosDbMongoDbApiLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| isServerVersionAbove32 | Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
CouchbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Couchbase' (required) |
| typeProperties | Couchbase server linked service properties. | CouchbaseLinkedServiceTypeProperties (required) |
CouchbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| credString | The Azure key vault secret reference of credString in connection string. | AzureKeyVaultSecretReference |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
CredentialReference
| Name | Description | Value |
|---|---|---|
| referenceName | Reference credential name. | string (required) |
| type | Credential reference type. | 'CredentialReference' (required) |
CustomDataSourceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'CustomDataSource' (required) |
| typeProperties | Custom linked service properties. | any (required) |
DataworldLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dataworld' (required) |
| typeProperties | Dataworld linked service properties. | DataworldLinkedServiceTypeProperties (required) |
DataworldLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Dataworld source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
Db2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Db2' (required) |
| typeProperties | DB2 linked service properties. | Db2LinkedServiceTypeProperties (required) |
Db2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. | 'Basic' |
| certificateCommonName | Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| connectionString | The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. | string |
| packageCollection | Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). | any |
DrillLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Drill' (required) |
| typeProperties | Drill server linked service properties. | DrillLinkedServiceTypeProperties (required) |
DrillLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
DynamicsAXLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsAX' (required) |
| typeProperties | Dynamics AX linked service properties. | DynamicsAXLinkedServiceTypeProperties (required) |
DynamicsAXLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | 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). | SecretBase (required) |
| tenant | 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). | any (required) |
| url | The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint. | any (required) |
DynamicsCrmLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'DynamicsCrm' (required) |
| typeProperties | Dynamics CRM linked service properties. | DynamicsCrmLinkedServiceTypeProperties (required) |
DynamicsCrmLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics CRM instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string). | any |
DynamicsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Dynamics' (required) |
| typeProperties | Dynamics linked service properties. | DynamicsLinkedServiceTypeProperties (required) |
DynamicsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). | any (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| deploymentType | 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). | any (required) |
| domain | The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hostName | 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). | any |
| organizationName | 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). | any |
| password | Password to access the Dynamics instance. | SecretBase |
| port | 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. | any |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). | any |
| serviceUri | 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). | any |
| username | User name to access the Dynamics instance. Type: string (or Expression with resultType string). | any |
EloquaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Eloqua' (required) |
| typeProperties | Eloqua server linked service properties. | EloquaLinkedServiceTypeProperties (required) |
EloquaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Eloqua server. (i.e. eloqua.example.com) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice) | any (required) |
FileServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FileServer' (required) |
| typeProperties | File system linked service properties. | FileServerLinkedServiceTypeProperties (required) |
FileServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the server. | SecretBase |
| userId | User ID to logon the server. Type: string (or Expression with resultType string). | any |
FtpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'FtpServer' (required) |
| typeProperties | Properties specific to this linked service type. | FtpServerLinkedServiceTypeProperties (required) |
FtpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Anonymous' 'Basic' |
| enableServerCertificateValidation | 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). | any |
| enableSsl | If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | Host name of the FTP server. Type: string (or Expression with resultType string). | any (required) |
| password | Password to logon the FTP server. | SecretBase |
| port | 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. | any |
| userName | Username to logon the FTP server. Type: string (or Expression with resultType string). | any |
GoogleAdWordsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleAdWords' (required) |
| typeProperties | Google AdWords service linked service properties. | GoogleAdWordsLinkedServiceTypeProperties (required) |
GoogleAdWordsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' |
| clientCustomerID | The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). | any |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| connectionProperties | (Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| developerToken | The developer token associated with the manager account that you use to grant access to the AdWords API. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| googleAdsApiVersion | 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). | any |
| keyFilePath | (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). | any |
| loginCustomerID | 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). | any |
| privateKey | The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. | SecretBase |
| refreshToken | The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. | SecretBase |
| supportLegacyDataTypes | 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). | any |
| trustedCertPath | (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). | any |
| useSystemTrustStore | (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). | any |
GoogleBigQueryLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQuery' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryLinkedServiceTypeProperties (required) |
GoogleBigQueryLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalProjects | A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string). | any |
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| 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). | any | |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFilePath | 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). | any |
| project | The default BigQuery project to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
| requestGoogleDriveScope | 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). | any |
| trustedCertPath | 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). | any |
| useSystemTrustStore | 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). | any |
GoogleBigQueryV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleBigQueryV2' (required) |
| typeProperties | Google BigQuery service linked service properties. | GoogleBigQueryV2LinkedServiceTypeProperties (required) |
GoogleBigQueryV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The OAuth 2.0 authentication mechanism used for authentication. | 'ServiceAuthentication' 'UserAuthentication' (required) |
| clientId | The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret of the google application used to acquire the refresh token. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| keyFileContent | The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). | SecretBase |
| projectId | The default BigQuery project id to query against. Type: string (or Expression with resultType string). | any (required) |
| refreshToken | The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. | SecretBase |
GoogleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleCloudStorage' (required) |
| typeProperties | Google Cloud Storage linked service properties. | GoogleCloudStorageLinkedServiceTypeProperties (required) |
GoogleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
GoogleSheetsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'GoogleSheets' (required) |
| typeProperties | GoogleSheets linked service properties. | GoogleSheetsLinkedServiceTypeProperties (required) |
GoogleSheetsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the GoogleSheets source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
GreenplumLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Greenplum' (required) |
| typeProperties | Greenplum Database linked service properties. | GreenplumLinkedServiceTypeProperties (required) |
GreenplumLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
HBaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HBase' (required) |
| typeProperties | HBase server linked service properties. | HBaseLinkedServiceTypeProperties (required) |
HBaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism to use to connect to the HBase server. | 'Anonymous' 'Basic' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the HBase server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the HBase instance uses to listen for client connections. The default value is 9090. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the HBase instance. | any |
HdfsLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hdfs' (required) |
| typeProperties | HDFS linked service properties. | HdfsLinkedServiceTypeProperties (required) |
HdfsLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Windows authentication. | SecretBase |
| url | The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Windows authentication. Type: string (or Expression with resultType string). | any |
HDInsightLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsight' (required) |
| typeProperties | HDInsight linked service properties. | HDInsightLinkedServiceTypeProperties (required) |
HDInsightLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clusterUri | HDInsight cluster URI. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| fileSystem | Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string). | any |
| hcatalogLinkedServiceName | A reference to the Azure SQL linked service that points to the HCatalog database. | LinkedServiceReference |
| isEspEnabled | Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean. | any |
| linkedServiceName | The Azure Storage linked service reference. | LinkedServiceReference |
| password | HDInsight cluster password. | SecretBase |
| userName | HDInsight cluster user name. Type: string (or Expression with resultType string). | any |
HDInsightOnDemandLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HDInsightOnDemand' (required) |
| typeProperties | HDInsight ondemand linked service properties. | HDInsightOnDemandLinkedServiceTypeProperties (required) |
HDInsightOnDemandLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| additionalLinkedServiceNames | Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. | LinkedServiceReference[] |
| clusterNamePrefix | The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). | any |
| clusterPassword | The password to access the cluster. | SecretBase |
| clusterResourceGroup | The resource group where the cluster belongs. Type: string (or Expression with resultType string). | any (required) |
| clusterSize | Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). | any (required) |
| clusterSshPassword | The password to SSH remotely connect cluster’s node (for Linux). | SecretBase |
| clusterSshUserName | The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string). | any |
| clusterType | The cluster type. Type: string (or Expression with resultType string). | any |
| clusterUserName | The username to access the cluster. Type: string (or Expression with resultType string). | any |
| coreConfiguration | Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| dataNodeSize | Specifies the size of the data node for the HDInsight cluster. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| hBaseConfiguration | Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. | any |
| hcatalogLinkedServiceName | 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. | LinkedServiceReference |
| hdfsConfiguration | Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. | any |
| headNodeSize | Specifies the size of the head node for the HDInsight cluster. | any |
| hiveConfiguration | Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. | any |
| hostSubscriptionId | The customer’s subscription to host the cluster. Type: string (or Expression with resultType string). | any (required) |
| linkedServiceName | Azure Storage linked service to be used by the on-demand cluster for storing and processing data. | LinkedServiceReference (required) |
| mapReduceConfiguration | Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. | any |
| oozieConfiguration | Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. | any |
| scriptActions | Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /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. | ScriptAction[] |
| servicePrincipalId | The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key for the service principal id. | SecretBase |
| sparkVersion | The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). | any |
| stormConfiguration | Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. | any |
| subnetName | 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). | any |
| tenant | The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). | any (required) |
| timeToLive | 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). | any (required) |
| version | Version of the HDInsight cluster. Type: string (or Expression with resultType string). | any (required) |
| virtualNetworkId | The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string). | any |
| yarnConfiguration | Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. | any |
| zookeeperNodeSize | Specifies the size of the Zoo Keeper node for the HDInsight cluster. | any |
HiveLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hive' (required) |
| typeProperties | Hive Server linked service properties. | HiveLinkedServiceTypeProperties (required) |
HiveLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Hive server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). | any (required) |
| httpPath | The partial URL corresponding to the Hive server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Hive server uses to listen for client connections. | any |
| serverType | The type of Hive server. | 'HiveServer1' 'HiveServer2' 'HiveThriftServer' |
| serviceDiscoveryMode | true to indicate using the ZooKeeper service, false not. | any |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| useNativeQuery | Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL. | any |
| username | The user name that you use to access Hive Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
| zooKeeperNameSpace | The namespace on ZooKeeper under which Hive Server 2 nodes are added. | any |
HttpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'HttpServer' (required) |
| typeProperties | Properties specific to this linked service type. | HttpLinkedServiceTypeProperties (required) |
HttpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the HTTP server. | 'Anonymous' 'Basic' 'ClientCertificate' 'Digest' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| certThumbprint | 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). | any |
| embeddedCertData | 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). | any |
| enableServerCertificateValidation | If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. | SecretBase |
| url | The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string). | any (required) |
| userName | User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string). | any |
HubspotLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Hubspot' (required) |
| typeProperties | Hubspot Service linked service properties. | HubspotLinkedServiceTypeProperties (required) |
HubspotLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token obtained when initially authenticating your OAuth integration. | SecretBase |
| clientId | The client ID associated with your Hubspot application. | any (required) |
| clientSecret | The client secret associated with your Hubspot application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| refreshToken | The refresh token obtained when initially authenticating your OAuth integration. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ImpalaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Impala' (required) |
| typeProperties | Impala server linked service properties. | ImpalaLinkedServiceTypeProperties (required) |
ImpalaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication type to use. | 'Anonymous' 'SASLUsername' 'UsernameAndPassword' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Impala server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name when using UsernameAndPassword. | SecretBase |
| port | The TCP port that the Impala server uses to listen for client connections. The default value is 21050. | any |
| trustedCertPath | 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. | any |
| username | The user name used to access the Impala server. The default value is anonymous when using SASLUsername. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
InformixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Informix' (required) |
| typeProperties | Informix linked service properties. | InformixLinkedServiceTypeProperties (required) |
InformixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
IntegrationRuntimeReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for integration runtime. | ParameterValueSpecification |
| referenceName | Reference integration runtime name. | string (required) |
| type | Type of integration runtime. | 'IntegrationRuntimeReference' (required) |
JiraLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Jira' (required) |
| typeProperties | Jira Service linked service properties. | JiraLinkedServiceTypeProperties (required) |
JiraLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Jira service. (e.g. jira.example.com) | any (required) |
| password | The password corresponding to the user name that you provided in the username field. | SecretBase |
| port | 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. | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name that you use to access Jira Service. | any (required) |
LakeHouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'LakeHouse' (required) |
| typeProperties | Microsoft Fabric LakeHouse linked service properties. | LakeHouseLinkedServiceTypeProperties (required) |
LakeHouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric LakeHouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
LinkedService
| Name | Description | Value |
|---|---|---|
| annotations | List of tags that can be used for describing the linked service. | any[] |
| connectVia | The integration runtime reference. | IntegrationRuntimeReference |
| description | Linked service description. | string |
| parameters | Parameters for linked service. | ParameterDefinitionSpecification |
| type | Set to 'AmazonMWS' for type AmazonMWSLinkedService. Set to 'AmazonRdsForOracle' for type AmazonRdsForOracleLinkedService. Set to 'AmazonRdsForSqlServer' for type AmazonRdsForSqlServerLinkedService. Set to 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AmazonS3Compatible' for type AmazonS3CompatibleLinkedService. Set to 'AppFigures' for type AppFiguresLinkedService. Set to 'Asana' for type AsanaLinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureBlobFS' for type AzureBlobFSLinkedService. Set to 'AzureBlobStorage' for type AzureBlobStorageLinkedService. Set to 'AzureDataExplorer' for type AzureDataExplorerLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureDatabricksDeltaLake' for type AzureDatabricksDeltaLakeLinkedService. Set to 'AzureFileStorage' for type AzureFileStorageLinkedService. Set to 'AzureFunction' for type AzureFunctionLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. Set to 'AzureMLService' for type AzureMLServiceLinkedService. Set to 'AzureMariaDB' for type AzureMariaDBLinkedService. Set to 'AzureMySql' for type AzureMySqlLinkedService. Set to 'AzurePostgreSql' for type AzurePostgreSqlLinkedService. Set to 'AzureSearch' for type AzureSearchLinkedService. Set to 'AzureSqlDW' for type AzureSqlDWLinkedService. Set to 'AzureSqlDatabase' for type AzureSqlDatabaseLinkedService. Set to 'AzureSqlMI' for type AzureSqlMILinkedService. Set to 'AzureStorage' for type AzureStorageLinkedService. Set to 'AzureSynapseArtifacts' for type AzureSynapseArtifactsLinkedService. Set to 'AzureTableStorage' for type AzureTableStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'CommonDataServiceForApps' for type CommonDataServiceForAppsLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'CosmosDbMongoDbApi' for type CosmosDbMongoDbApiLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Dataworld' for type DataworldLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'DynamicsAX' for type DynamicsAXLinkedService. Set to 'DynamicsCrm' for type DynamicsCrmLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleAdWords' for type GoogleAdWordsLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. Set to 'GoogleBigQueryV2' for type GoogleBigQueryV2LinkedService. Set to 'GoogleCloudStorage' for type GoogleCloudStorageLinkedService. Set to 'GoogleSheets' for type GoogleSheetsLinkedService. Set to 'Greenplum' for type GreenplumLinkedService. Set to 'HBase' for type HBaseLinkedService. Set to 'HDInsight' for type HDInsightLinkedService. Set to 'HDInsightOnDemand' for type HDInsightOnDemandLinkedService. Set to 'Hdfs' for type HdfsLinkedService. Set to 'Hive' for type HiveLinkedService. Set to 'HttpServer' for type HttpLinkedService. Set to 'Hubspot' for type HubspotLinkedService. Set to 'Impala' for type ImpalaLinkedService. Set to 'Informix' for type InformixLinkedService. Set to 'Jira' for type JiraLinkedService. Set to 'LakeHouse' for type LakeHouseLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MicrosoftAccess' for type MicrosoftAccessLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. Set to 'MongoDbAtlas' for type MongoDbAtlasLinkedService. Set to 'MongoDbV2' for type MongoDbV2LinkedService. Set to 'MySql' for type MySqlLinkedService. Set to 'Netezza' for type NetezzaLinkedService. Set to 'OData' for type ODataLinkedService. Set to 'Odbc' for type OdbcLinkedService. Set to 'Office365' for type Office365LinkedService. Set to 'Oracle' for type OracleLinkedService. Set to 'OracleCloudStorage' for type OracleCloudStorageLinkedService. Set to 'OracleServiceCloud' for type OracleServiceCloudLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'PostgreSqlV2' for type PostgreSqlV2LinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Quickbase' for type QuickbaseLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'RestService' for type RestServiceLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. Set to 'SalesforceServiceCloud' for type SalesforceServiceCloudLinkedService. Set to 'SalesforceServiceCloudV2' for type SalesforceServiceCloudV2LinkedService. Set to 'SalesforceV2' for type SalesforceV2LinkedService. Set to 'SapBW' for type SapBWLinkedService. Set to 'SapCloudForCustomer' for type SapCloudForCustomerLinkedService. Set to 'SapEcc' for type SapEccLinkedService. Set to 'SapHana' for type SapHanaLinkedService. Set to 'SapOdp' for type SapOdpLinkedService. Set to 'SapOpenHub' for type SapOpenHubLinkedService. Set to 'SapTable' for type SapTableLinkedService. Set to 'ServiceNow' for type ServiceNowLinkedService. Set to 'ServiceNowV2' for type ServiceNowV2LinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'SharePointOnlineList' for type SharePointOnlineListLinkedService. Set to 'Shopify' for type ShopifyLinkedService. Set to 'Smartsheet' for type SmartsheetLinkedService. Set to 'Snowflake' for type SnowflakeLinkedService. Set to 'SnowflakeV2' for type SnowflakeV2LinkedService. Set to 'Spark' for type SparkLinkedService. Set to 'SqlServer' for type SqlServerLinkedService. Set to 'Square' for type SquareLinkedService. Set to 'Sybase' for type SybaseLinkedService. Set to 'TeamDesk' for type TeamDeskLinkedService. Set to 'Teradata' for type TeradataLinkedService. Set to 'Twilio' for type TwilioLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Warehouse' for type WarehouseLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zendesk' for type ZendeskLinkedService. Set to 'Zoho' for type ZohoLinkedService. | 'AmazonMWS' 'AmazonRdsForOracle' 'AmazonRdsForSqlServer' 'AmazonRedshift' 'AmazonS3' 'AmazonS3Compatible' 'AppFigures' 'Asana' 'AzureBatch' 'AzureBlobFS' 'AzureBlobStorage' 'AzureDatabricks' 'AzureDatabricksDeltaLake' 'AzureDataExplorer' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureFileStorage' 'AzureFunction' 'AzureKeyVault' 'AzureMariaDB' 'AzureML' 'AzureMLService' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureSqlMI' 'AzureStorage' 'AzureSynapseArtifacts' 'AzureTableStorage' 'Cassandra' 'CommonDataServiceForApps' 'Concur' 'CosmosDb' 'CosmosDbMongoDbApi' 'Couchbase' 'CustomDataSource' 'Dataworld' 'Db2' 'Drill' 'Dynamics' 'DynamicsAX' 'DynamicsCrm' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleAdWords' 'GoogleBigQuery' 'GoogleBigQueryV2' 'GoogleCloudStorage' 'GoogleSheets' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Informix' 'Jira' 'LakeHouse' 'Magento' 'MariaDB' 'Marketo' 'MicrosoftAccess' 'MongoDb' 'MongoDbAtlas' 'MongoDbV2' 'MySql' 'Netezza' 'OData' 'Odbc' 'Office365' 'Oracle' 'OracleCloudStorage' 'OracleServiceCloud' 'Paypal' 'Phoenix' 'PostgreSql' 'PostgreSqlV2' 'Presto' 'Quickbase' 'QuickBooks' 'Responsys' 'RestService' 'Salesforce' 'SalesforceMarketingCloud' 'SalesforceServiceCloud' 'SalesforceServiceCloudV2' 'SalesforceV2' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'SapOdp' 'SapOpenHub' 'SapTable' 'ServiceNow' 'ServiceNowV2' 'Sftp' 'SharePointOnlineList' 'Shopify' 'Smartsheet' 'Snowflake' 'SnowflakeV2' 'Spark' 'SqlServer' 'Square' 'Sybase' 'TeamDesk' 'Teradata' 'Twilio' 'Vertica' 'Warehouse' 'Web' 'Xero' 'Zendesk' 'Zoho' (required) |
| version | Version of the linked service. | string |
LinkedServiceReference
| Name | Description | Value |
|---|---|---|
| parameters | Arguments for LinkedService. | ParameterValueSpecification |
| referenceName | Reference LinkedService name. | string (required) |
| type | Linked service reference type. | 'LinkedServiceReference' (required) |
MagentoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Magento' (required) |
| typeProperties | Magento server linked service properties. | MagentoLinkedServiceTypeProperties (required) |
MagentoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token from Magento. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Magento instance. (i.e. 192.168.222.110/magento3) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
MariaDBLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MariaDB' (required) |
| typeProperties | MariaDB server linked service properties. | MariaDBLinkedServiceTypeProperties (required) |
MariaDBLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslMode | This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default) | any |
MarketoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Marketo' (required) |
| typeProperties | Marketo server linked service properties. | MarketoLinkedServiceTypeProperties (required) |
MarketoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client Id of your Marketo service. | any (required) |
| clientSecret | The client secret of your Marketo service. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
Microsoft.DataFactory/factories/linkedservices
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: factories |
| properties | Properties of linked service. | LinkedService (required) |
| type | The resource type | "Microsoft.DataFactory/factories/linkedservices@2018-06-01" |
MicrosoftAccessLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MicrosoftAccess' (required) |
| typeProperties | Microsoft Access linked service properties. | MicrosoftAccessLinkedServiceTypeProperties (required) |
MicrosoftAccessLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | 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). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
MongoDbAtlasLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbAtlas' (required) |
| typeProperties | MongoDB Atlas linked service properties. | MongoDbAtlasLinkedServiceTypeProperties (required) |
MongoDbAtlasLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| driverVersion | The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string). | any |
MongoDbLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDb' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbLinkedServiceTypeProperties (required) |
MongoDbLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| authenticationType | The authentication type to be used to connect to the MongoDB database. | 'Anonymous' 'Basic' |
| authSource | Database to verify the username and password. Type: string (or Expression with resultType string). | any |
| databaseName | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| port | 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. | any |
| server | The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
MongoDbV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MongoDbV2' (required) |
| typeProperties | MongoDB linked service properties. | MongoDbV2LinkedServiceTypeProperties (required) |
MongoDbV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| database | The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). | any (required) |
MySqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'MySql' (required) |
| typeProperties | MySQL linked service properties. | MySqlLinkedServiceTypeProperties (required) |
MySqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowZeroDateTime | This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean. | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectionTimeout | The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer. | any |
| convertZeroDateTime | True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean. | any |
| database | Database name for connection. Type: string. | any |
| driverVersion | 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. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| guidFormat | Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID. | any |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| port | The port for the connection. Type: integer. | any |
| server | Server name for connection. Type: string. | any |
| sslCert | The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string. | any |
| sslKey | The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full. | any |
| treatTinyAsBoolean | When set to true, TINYINT(1) values are returned as booleans. Type: bool. | any |
| username | Username for authentication. Type: string. | any |
| useSystemTrustStore | Use system trust store for connection. Type: integer. 0: enable, 1: disable. | any |
NetezzaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Netezza' (required) |
| typeProperties | Netezza linked service properties. | NetezzaLinkedServiceTypeProperties (required) |
NetezzaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
ODataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OData' (required) |
| typeProperties | OData linked service properties. | ODataLinkedServiceTypeProperties (required) |
ODataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). | any |
| aadServicePrincipalCredentialType | Specify the credential type (key or cert) is used for service principal. | 'ServicePrincipalCert' 'ServicePrincipalKey' |
| authenticationType | Type of authentication used to connect to the OData service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'Windows' |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). | any |
| azureCloudType | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password of the OData service. | SecretBase |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| tenant | Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). | any |
| url | The URL of the OData service endpoint. Type: string (or Expression with resultType string). | any (required) |
| userName | User name of the OData service. Type: string (or Expression with resultType string). | any |
OdbcLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Odbc' (required) |
| typeProperties | ODBC linked service properties. | OdbcLinkedServiceTypeProperties (required) |
OdbcLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). | any |
| connectionString | 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. | any (required) |
| credential | The access credential portion of the connection string specified in driver-specific property-value format. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for Basic authentication. | SecretBase |
| userName | User name for Basic authentication. Type: string (or Expression with resultType string). | any |
Office365LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Office365' (required) |
| typeProperties | Office365 linked service properties. | Office365LinkedServiceTypeProperties (required) |
Office365LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| office365TenantId | Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalId | Specify the application's client ID. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalKey | Specify the application's key. | SecretBase (required) |
| servicePrincipalTenantId | Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleCloudStorage' (required) |
| typeProperties | Oracle Cloud Storage linked service properties. | OracleCloudStorageLinkedServiceTypeProperties (required) |
OracleCloudStorageLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessKeyId | The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| secretAccessKey | The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. | SecretBase |
| serviceUrl | 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). | any |
OracleLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Oracle' (required) |
| typeProperties | Oracle database linked service properties. | OracleLinkedServiceTypeProperties (required) |
OracleLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
OracleServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'OracleServiceCloud' (required) |
| typeProperties | Oracle Service Cloud linked service properties. | OracleServiceCloudLinkedServiceTypeProperties (required) |
OracleServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Oracle Service Cloud instance. | any (required) |
| password | The password corresponding to the user name that you provided in the username key. | SecretBase (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
| username | The user name that you use to access Oracle Service Cloud server. | any (required) |
ParameterDefinitionSpecification
| Name | Description | Value |
|---|
ParameterSpecification
| Name | Description | Value |
|---|---|---|
| defaultValue | Default value of parameter. | any |
| type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
| Name | Description | Value |
|---|
ParameterValueSpecification
| Name | Description | Value |
|---|
PaypalLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Paypal' (required) |
| typeProperties | Paypal Service linked service properties. | PaypalLinkedServiceTypeProperties (required) |
PaypalLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your PayPal application. | any (required) |
| clientSecret | The client secret associated with your PayPal application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
PhoenixLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Phoenix' (required) |
| typeProperties | Phoenix server linked service properties. | PhoenixLinkedServiceTypeProperties (required) |
PhoenixLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Phoenix server. | 'Anonymous' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) | any (required) |
| httpPath | The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. | any |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Phoenix server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
PostgreSqlLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSql' (required) |
| typeProperties | PostgreSQL linked service properties. | PostgreSqlLinkedServiceTypeProperties (required) |
PostgreSqlLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
PostgreSqlV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'PostgreSqlV2' (required) |
| typeProperties | PostgreSQLV2 linked service properties. | PostgreSqlV2LinkedServiceTypeProperties (required) |
PostgreSqlV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. Type: string. | any (required) |
| commandTimeout | 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. | any |
| connectionTimeout | The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. | any |
| database | Database name for connection. Type: string. | any (required) |
| encoding | Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| logParameters | When enabled, parameter values are logged when commands are executed. Type: boolean. | any |
| password | The Azure key vault secret reference of password in connection string. Type: string. | AzureKeyVaultSecretReference |
| pooling | Whether connection pooling should be used. Type: boolean. | any |
| port | The port for the connection. Type: integer. | any |
| readBufferSize | Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. | any |
| schema | Sets the schema search path. Type: string. | any |
| server | Server name for connection. Type: string. | any (required) |
| sslCertificate | Location of a client certificate to be sent to the server. Type: string. | any |
| sslKey | Location of a client key for a client certificate to be sent to the server. Type: string. | any |
| sslMode | SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. | any (required) |
| sslPassword | Password for a key for a client certificate. Type: string. | any |
| timezone | Gets or sets the session timezone. Type: string. | any |
| trustServerCertificate | Whether to trust the server certificate without validating it. Type: boolean. | any |
| username | Username for authentication. Type: string. | any (required) |
PrestoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Presto' (required) |
| typeProperties | Presto server linked service properties. | PrestoLinkedServiceTypeProperties (required) |
PrestoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication mechanism used to connect to the Presto server. | 'Anonymous' 'LDAP' (required) |
| catalog | The catalog context for all request against the server. | any (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The IP address or host name of the Presto server. (i.e. 192.168.222.160) | any (required) |
| password | The password corresponding to the user name. | SecretBase |
| port | The TCP port that the Presto server uses to listen for client connections. The default value is 8080. | any |
| serverVersion | The version of the Presto server. (i.e. 0.148-t) | any (required) |
| timeZoneID | 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. | any |
| trustedCertPath | 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. | any |
| username | The user name used to connect to the Presto server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
QuickbaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Quickbase' (required) |
| typeProperties | Quickbase linked service properties. | QuickbaseLinkedServiceTypeProperties (required) |
QuickbaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| url | The url to connect Quickbase source. Type: string (or Expression with resultType string). | any (required) |
| userToken | The user token for the Quickbase source. | SecretBase (required) |
QuickBooksLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'QuickBooks' (required) |
| typeProperties | QuickBooks server linked service properties. | QuickBooksLinkedServiceTypeProperties (required) |
QuickBooksLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for OAuth 1.0 authentication. | SecretBase |
| accessTokenSecret | The access token secret for OAuth 1.0 authentication. | SecretBase |
| companyId | The company ID of the QuickBooks company to authorize. | any |
| connectionProperties | Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key for OAuth 1.0 authentication. | any |
| consumerSecret | The consumer secret for OAuth 1.0 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
ResponsysLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Responsys' (required) |
| typeProperties | Responsys linked service properties. | ResponsysLinkedServiceTypeProperties (required) |
ResponsysLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Responsys application. Type: string (or Expression with resultType string). | any (required) |
| clientSecret | The client secret associated with the Responsys application. Type: string (or Expression with resultType string). | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Responsys server. | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
RestServiceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'RestService' (required) |
| typeProperties | Rest Service linked service properties. | RestServiceLinkedServiceTypeProperties (required) |
RestServiceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| aadResourceId | The resource you are requesting authorization to use. Type: string (or Expression with resultType string). | any |
| authenticationType | Type of authentication used to connect to the REST service. | 'AadServicePrincipal' 'Anonymous' 'Basic' 'ManagedServiceIdentity' 'OAuth2ClientCredential' (required) |
| authHeaders | The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object). | any |
| azureCloudType | 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). | any |
| clientId | The client ID associated with your application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with your application. | SecretBase |
| credential | The credential reference containing authentication information. | CredentialReference |
| enableServerCertificateValidation | Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password used in Basic authentication type. | SecretBase |
| resource | The target service or resource to which the access will be requested. Type: string (or Expression with resultType string). | any |
| scope | The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string). | any |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The application's key used in AadServicePrincipal authentication type. | SecretBase |
| tenant | 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). | any |
| tokenEndpoint | The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string). | any |
| url | The base URL of the REST service. Type: string (or Expression with resultType string). | any (required) |
| userName | The user name used in Basic authentication type. Type: string (or Expression with resultType string). | any |
SalesforceLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Salesforce' (required) |
| typeProperties | Salesforce linked service properties. | SalesforceLinkedServiceTypeProperties (required) |
SalesforceLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceMarketingCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceMarketingCloud' (required) |
| typeProperties | Salesforce Marketing Cloud linked service properties. | SalesforceMarketingCloudLinkedServiceTypeProperties (required) |
SalesforceMarketingCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). | SecretBase |
| connectionProperties | Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
| useHostVerification | 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). | any |
| usePeerVerification | 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). | any |
SalesforceServiceCloudLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloud' (required) |
| typeProperties | Salesforce Service Cloud linked service properties. | SalesforceServiceCloudLinkedServiceTypeProperties (required) |
SalesforceServiceCloudLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | The Salesforce API version used in ADF. Type: string (or Expression with resultType string). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | 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). | any |
| extendedProperties | Extended properties appended to the connection string. Type: string (or Expression with resultType string). | any |
| password | The password for Basic authentication of the Salesforce instance. | SecretBase |
| securityToken | The security token is optional to remotely access Salesforce instance. | SecretBase |
| username | The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
SalesforceServiceCloudV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceServiceCloudV2' (required) |
| typeProperties | Salesforce Service Cloud V2 linked service properties. | SalesforceServiceCloudV2LinkedServiceTypeProperties (required) |
SalesforceServiceCloudV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SalesforceV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SalesforceV2' (required) |
| typeProperties | Salesforce V2 linked service properties. | SalesforceV2LinkedServiceTypeProperties (required) |
SalesforceV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiVersion | 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). | any |
| authenticationType | The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value | any |
| clientId | The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). | any |
| clientSecret | The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| environmentUrl | The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). | any |
SapBWLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapBW' (required) |
| typeProperties | Properties specific to this linked service type. | SapBWLinkedServiceTypeProperties (required) |
SapBWLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP BW server. | SecretBase |
| server | Host name of the SAP BW instance. Type: string (or Expression with resultType string). | any (required) |
| systemNumber | System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). | any (required) |
| userName | Username to access the SAP BW server. Type: string (or Expression with resultType string). | any |
SapCloudForCustomerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapCloudForCustomer' (required) |
| typeProperties | SAP Cloud for Customer linked service properties. | SapCloudForCustomerLinkedServiceTypeProperties (required) |
SapCloudForCustomerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | 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). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapEccLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapEcc' (required) |
| typeProperties | SAP ECC linked service properties. | SapEccLinkedServiceTypeProperties (required) |
SapEccLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | 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. | string |
| password | The password for Basic authentication. | SecretBase |
| url | The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). | any (required) |
| username | The username for Basic authentication. Type: string (or Expression with resultType string). | any |
SapHanaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapHana' (required) |
| typeProperties | Properties specific to this linked service type. | SapHanaLinkedServiceProperties (required) |
SapHanaLinkedServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the SAP HANA server. | 'Basic' 'Windows' |
| connectionString | SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password to access the SAP HANA server. | SecretBase |
| server | Host name of the SAP HANA server. Type: string (or Expression with resultType string). | any |
| userName | Username to access the SAP HANA server. Type: string (or Expression with resultType string). | any |
SapOdpLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOdp' (required) |
| typeProperties | Properties specific to SAP ODP linked service type. | SapOdpLinkedServiceTypeProperties (required) |
SapOdpLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| subscriberName | The subscriber name. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| x509CertificatePath | SNC X509 certificate file path. Type: string (or Expression with resultType string). | any |
SapOpenHubLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapOpenHub' (required) |
| typeProperties | Properties specific to SAP Business Warehouse Open Hub Destination linked service type. | SapOpenHubLinkedServiceTypeProperties (required) |
SapOpenHubLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP BW server where the open hub destination is located. | SecretBase |
| server | Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string). | any |
SapTableLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SapTable' (required) |
| typeProperties | Properties specific to this linked service type. | SapTableLinkedServiceTypeProperties (required) |
SapTableLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| language | Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). | any |
| logonGroup | The Logon Group for the SAP System. Type: string (or Expression with resultType string). | any |
| messageServer | The hostname of the SAP Message Server. Type: string (or Expression with resultType string). | any |
| messageServerService | The service name or port number of the Message Server. Type: string (or Expression with resultType string). | any |
| password | Password to access the SAP server where the table is located. | SecretBase |
| server | Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). | any |
| sncLibraryPath | External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncMode | 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). | any |
| sncMyName | Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncPartnerName | Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
| sncQop | SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). | any |
| systemId | SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). | any |
| systemNumber | 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). | any |
| userName | Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). | any |
ScriptAction
| Name | Description | Value |
|---|---|---|
| name | The user provided name of the script action. | string (required) |
| parameters | The parameters for the script action. | string |
| roles | The node types on which the script action should be executed. | any (required) |
| uri | The URI for the script action. | string (required) |
SecretBase
| Name | Description | Value |
|---|---|---|
| type | Set to 'AzureKeyVaultSecret' for type AzureKeyVaultSecretReference. Set to 'SecureString' for type SecureString. | 'AzureKeyVaultSecret' 'SecureString' (required) |
SecureString
| Name | Description | Value |
|---|---|---|
| type | Type of the secret. | 'SecureString' (required) |
| value | Value of secure string. | string (required) |
ServiceNowLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNow' (required) |
| typeProperties | ServiceNow server linked service properties. | ServiceNowLinkedServiceTypeProperties (required) |
ServiceNowLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com) | any (required) |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
| username | The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. | any |
ServiceNowV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'ServiceNowV2' (required) |
| typeProperties | ServiceNowV2 server linked service properties. | ServiceNowV2LinkedServiceTypeProperties (required) |
ServiceNowV2LinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to use. | 'Basic' 'OAuth2' (required) |
| clientId | The client id for OAuth2 authentication. | any |
| clientSecret | The client secret for OAuth2 authentication. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the ServiceNowV2 server. (i.e. <instance>.service-now.com) | any (required) |
| grantType | GrantType for OAuth2 authentication. Default value is password. | any |
| password | The password corresponding to the user name for Basic and OAuth2 authentication. | SecretBase |
| username | The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication. | any |
SftpServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sftp' (required) |
| typeProperties | Properties specific to this linked service type. | SftpServerLinkedServiceTypeProperties (required) |
SftpServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | The authentication type to be used to connect to the FTP server. | 'Basic' 'MultiFactor' 'SshPublicKey' |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The SFTP server host name. Type: string (or Expression with resultType string). | any (required) |
| hostKeyFingerprint | The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). | any |
| passPhrase | The password to decrypt the SSH private key if the SSH private key is encrypted. | SecretBase |
| password | Password to logon the SFTP server for Basic authentication. | SecretBase |
| port | 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. | any |
| privateKeyContent | 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. | SecretBase |
| privateKeyPath | 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). | any |
| skipHostKeyValidation | If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). | any |
| userName | The username used to log on to the SFTP server. Type: string (or Expression with resultType string). | any |
SharePointOnlineListLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SharePointOnlineList' (required) |
| typeProperties | SharePoint Online List linked service properties. | SharePointOnlineListLinkedServiceTypeProperties (required) |
SharePointOnlineListLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalEmbeddedCert | Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| servicePrincipalEmbeddedCertPassword | 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). | SecretBase |
| servicePrincipalId | 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). | any (required) |
| servicePrincipalKey | The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). | SecretBase |
| siteUrl | The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string). | any (required) |
| tenantId | 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). | any (required) |
ShopifyLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Shopify' (required) |
| typeProperties | Shopify Service linked service properties. | ShopifyLinkedServiceTypeProperties (required) |
ShopifyLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Shopify server. (i.e. mystore.myshopify.com) | any (required) |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SmartsheetLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Smartsheet' (required) |
| typeProperties | Smartsheet linked service properties. | SmartsheetLinkedServiceTypeProperties (required) |
SmartsheetLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Smartsheet source. | SecretBase (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
SnowflakeLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Snowflake' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedServiceTypeProperties (required) |
SnowflakeLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | The connection string of snowflake. Type: string, SecureString. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
SnowflakeLinkedV2ServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accountIdentifier | The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure | any (required) |
| authenticationType | The type used for authentication. Type: string. | 'AADServicePrincipal' 'Basic' 'KeyPair' |
| clientId | The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| clientSecret | The Azure key vault secret reference of client secret for AADServicePrincipal authentication. | SecretBase |
| database | The name of the Snowflake database. | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The host name of the Snowflake account. | any |
| password | The Azure key vault secret reference of password in connection string. | SecretBase |
| privateKey | The Azure key vault secret reference of privateKey for KeyPair auth. | SecretBase |
| privateKeyPassphrase | The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. | SecretBase |
| scope | The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| tenantId | The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. | any |
| user | The name of the Snowflake user. | any |
| warehouse | The name of the Snowflake warehouse. | any (required) |
SnowflakeV2LinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SnowflakeV2' (required) |
| typeProperties | Snowflake linked service properties. | SnowflakeLinkedV2ServiceTypeProperties (required) |
SparkLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Spark' (required) |
| typeProperties | Spark Server linked service properties. | SparkLinkedServiceTypeProperties (required) |
SparkLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| allowHostNameCNMismatch | 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. | any |
| allowSelfSignedServerCert | Specifies whether to allow self-signed certificates from the server. The default value is false. | any |
| authenticationType | The authentication method used to access the Spark server. | 'Anonymous' 'Username' 'UsernameAndPassword' 'WindowsAzureHDInsightService' (required) |
| enableSsl | Specifies whether the connections to the server are encrypted using SSL. The default value is false. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | IP address or host name of the Spark server | any (required) |
| httpPath | The partial URL corresponding to the Spark server. | any |
| password | The password corresponding to the user name that you provided in the Username field | SecretBase |
| port | The TCP port that the Spark server uses to listen for client connections. | any (required) |
| serverType | The type of Spark server. | 'SharkServer' 'SharkServer2' 'SparkThriftServer' |
| thriftTransportProtocol | The transport protocol to use in the Thrift layer. | 'Binary' 'HTTP ' 'SASL' |
| trustedCertPath | 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. | any |
| username | The user name that you use to access Spark Server. | any |
| useSystemTrustStore | Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. | any |
SqlAlwaysEncryptedProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedAkvAuthType | Sql always encrypted AKV authentication type. Type: string. | 'ManagedIdentity' 'ServicePrincipal' 'UserAssignedManagedIdentity' (required) |
| credential | The credential reference containing authentication information. | CredentialReference |
| servicePrincipalId | The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The key of the service principal used to authenticate against Azure Key Vault. | SecretBase |
SqlServerLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'SqlServer' (required) |
| typeProperties | SQL Server linked service properties. | SqlServerLinkedServiceTypeProperties (required) |
SqlServerLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| alwaysEncryptedSettings | Sql always encrypted properties. | SqlAlwaysEncryptedProperties |
| applicationIntent | 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). | any |
| authenticationType | The type used for authentication. Type: string. | 'SQL' 'UserAssignedManagedIdentity' 'Windows' |
| commandTimeout | 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). | any |
| connectionString | The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| connectRetryCount | 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). | any |
| connectRetryInterval | 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). | any |
| connectTimeout | 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). | any |
| credential | The credential reference containing authentication information. | CredentialReference |
| database | The name of the database, used by recommended version. Type: string (or Expression with resultType string). | any |
| encrypt | 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). | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| failoverPartner | 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). | any |
| hostNameInCertificate | 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). | any |
| integratedSecurity | 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). | any |
| loadBalanceTimeout | 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). | any |
| maxPoolSize | 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). | any |
| minPoolSize | 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). | any |
| multipleActiveResultSets | 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). | any |
| multiSubnetFailover | 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). | any |
| packetSize | 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). | any |
| password | The on-premises Windows authentication password. | SecretBase |
| pooling | 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). | any |
| server | 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). | any |
| trustServerCertificate | 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). | any |
| userName | The on-premises Windows authentication user name. Type: string (or Expression with resultType string). | any |
SquareLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Square' (required) |
| typeProperties | Square Service linked service properties. | SquareLinkedServiceTypeProperties (required) |
SquareLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client ID associated with your Square application. | any |
| clientSecret | The client secret associated with your Square application. | SecretBase |
| connectionProperties | Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The URL of the Square instance. (i.e. mystore.mysquare.com) | any |
| redirectUri | The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
SybaseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Sybase' (required) |
| typeProperties | Sybase linked service properties. | SybaseLinkedServiceTypeProperties (required) |
SybaseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| database | Database name for connection. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| schema | Schema name for connection. Type: string (or Expression with resultType string). | any |
| server | Server name for connection. Type: string (or Expression with resultType string). | any (required) |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TeamDeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'TeamDesk' (required) |
| typeProperties | TeamDesk linked service properties. | TeamDeskLinkedServiceTypeProperties (required) |
TeamDeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the TeamDesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the TeamDesk source. | SecretBase |
| url | The url to connect TeamDesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the TeamDesk source. Type: string (or Expression with resultType string). | any |
TeradataLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Teradata' (required) |
| typeProperties | Teradata linked service properties. | TeradataLinkedServiceTypeProperties (required) |
TeradataLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | AuthenticationType to be used for connection. | 'Basic' 'Windows' |
| connectionString | Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | Password for authentication. | SecretBase |
| server | Server name for connection. Type: string (or Expression with resultType string). | any |
| username | Username for authentication. Type: string (or Expression with resultType string). | any |
TwilioLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Twilio' (required) |
| typeProperties | Twilio linked service properties. | TwilioLinkedServiceTypeProperties (required) |
TwilioLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| password | The auth token of Twilio service. | SecretBase (required) |
| userName | The Account SID of Twilio service. Type: string (or Expression with resultType string). | any (required) |
VerticaLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Vertica' (required) |
| typeProperties | Vertica linked service properties. | VerticaLinkedServiceTypeProperties (required) |
VerticaLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionString | An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. | any |
| database | Database name for connection. Type: string. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| port | The port for the connection. Type: integer. | any |
| pwd | The Azure key vault secret reference of password in connection string. | AzureKeyVaultSecretReference |
| server | Server name for connection. Type: string. | any |
| uid | Username for authentication. Type: string. | any |
WarehouseLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Warehouse' (required) |
| typeProperties | Microsoft Fabric Warehouse linked service properties. | WarehouseLinkedServiceTypeProperties (required) |
WarehouseLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| artifactId | The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string). | any (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string). | any (required) |
| servicePrincipalCredential | 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. | SecretBase |
| servicePrincipalCredentialType | 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). | any |
| servicePrincipalId | The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
| servicePrincipalKey | The Key of the application used to authenticate against Microsoft Fabric Warehouse. | SecretBase |
| tenant | The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). | any |
| workspaceId | The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). | any |
WebAnonymousAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Anonymous' (required) |
WebBasicAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'Basic' (required) |
| password | The password for Basic authentication. | SecretBase (required) |
| username | User name for Basic authentication. Type: string (or Expression with resultType string). | any (required) |
WebClientCertificateAuthentication
| Name | Description | Value |
|---|---|---|
| authenticationType | Type of authentication used to connect to the web table source. | 'ClientCertificate' (required) |
| password | Password for the PFX file. | SecretBase (required) |
| pfx | Base64-encoded contents of a PFX file. | SecretBase (required) |
WebLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Web' (required) |
| typeProperties | Web linked service properties. | WebLinkedServiceTypeProperties (required) |
WebLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| authenticationType | Set to 'Anonymous' for type WebAnonymousAuthentication. Set to 'Basic' for type WebBasicAuthentication. Set to 'ClientCertificate' for type WebClientCertificateAuthentication. | 'Anonymous' 'Basic' 'ClientCertificate' (required) |
| url | The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). | any (required) |
XeroLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Xero' (required) |
| typeProperties | Xero Service linked service properties. | XeroLinkedServiceTypeProperties (required) |
XeroLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| connectionProperties | Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| consumerKey | The consumer key associated with the Xero application. | SecretBase |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| host | The endpoint of the Xero server. (i.e. api.xero.com) | any |
| privateKey | 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( ). |
SecretBase |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |
ZendeskLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zendesk' (required) |
| typeProperties | Zendesk linked service properties. | ZendeskLinkedServiceTypeProperties (required) |
ZendeskLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| apiToken | The api token for the Zendesk source. | SecretBase |
| authenticationType | The authentication type to use. | 'Basic' 'Token' (required) |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| password | The password of the Zendesk source. | SecretBase |
| url | The url to connect Zendesk source. Type: string (or Expression with resultType string). | any (required) |
| userName | The username of the Zendesk source. Type: string (or Expression with resultType string). | any |
ZohoLinkedService
| Name | Description | Value |
|---|---|---|
| type | Type of linked service. | 'Zoho' (required) |
| typeProperties | Zoho server linked service properties. | ZohoLinkedServiceTypeProperties (required) |
ZohoLinkedServiceTypeProperties
| Name | Description | Value |
|---|---|---|
| accessToken | The access token for Zoho authentication. | SecretBase |
| connectionProperties | Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object. | any |
| encryptedCredential | The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. | string |
| endpoint | The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) | any |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | any |
| useHostVerification | 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. | any |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. | any |