Microsoft.DataFactory factories/linkedservices 2017-09-01-preview

• Latest
• 2018-06-01
• 2017-09-01-preview

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@2017-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    annotations: [
      any(...)
    ]
    connectVia: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    description: 'string'
    parameters: {
      {customized property}: {
        defaultValue: any(...)
        type: '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(...)
    encryptedCredential: any(...)
    endpoint: any(...)
    marketplaceID: any(...)
    mwsAuthToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    secretKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sellerID: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For AmazonRedshift, use:

{
  type: 'AmazonRedshift'
  typeProperties: {
    database: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    server: any(...)
    username: any(...)
  }
}

For AmazonS3, use:

{
  type: 'AmazonS3'
  typeProperties: {
    accessKeyId: any(...)
    encryptedCredential: any(...)
    secretAccessKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }
}

For AzureBatch, use:

{
  type: 'AzureBatch'
  typeProperties: {
    accessKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    accountName: any(...)
    batchUri: any(...)
    encryptedCredential: any(...)
    linkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    poolName: any(...)
  }
}

For AzureDataLakeAnalytics, use:

{
  type: 'AzureDataLakeAnalytics'
  typeProperties: {
    accountName: any(...)
    dataLakeAnalyticsUri: any(...)
    encryptedCredential: any(...)
    resourceGroupName: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    subscriptionId: any(...)
    tenant: any(...)
  }
}

For AzureDataLakeStore, use:

{
  type: 'AzureDataLakeStore'
  typeProperties: {
    accountName: any(...)
    dataLakeStoreUri: any(...)
    encryptedCredential: any(...)
    resourceGroupName: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    subscriptionId: any(...)
    tenant: any(...)
  }
}

For AzureDatabricks, use:

{
  type: 'AzureDatabricks'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    domain: any(...)
    encryptedCredential: any(...)
    existingClusterId: any(...)
    newClusterNodeType: any(...)
    newClusterNumOfWorker: any(...)
    newClusterSparkConf: {
      {customized property}: any(...)
    }
    newClusterVersion: any(...)
  }
}

For AzureKeyVault, use:

{
  type: 'AzureKeyVault'
  typeProperties: {
    baseUrl: any(...)
  }
}

For AzureML, use:

{
  type: 'AzureML'
  typeProperties: {
    apiKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    mlEndpoint: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any(...)
    updateResourceEndpoint: any(...)
  }
}

For AzureMySql, use:

{
  type: 'AzureMySql'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For AzurePostgreSql, use:

{
  type: 'AzurePostgreSql'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For AzureSearch, use:

{
  type: 'AzureSearch'
  typeProperties: {
    encryptedCredential: any(...)
    key: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: any(...)
  }
}

For AzureSqlDW, use:

{
  type: 'AzureSqlDW'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any(...)
  }
}

For AzureSqlDatabase, use:

{
  type: 'AzureSqlDatabase'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any(...)
  }
}

For AzureStorage, use:

{
  type: 'AzureStorage'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
    sasUri: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }
}

For Cassandra, use:

{
  type: 'Cassandra'
  typeProperties: {
    authenticationType: any(...)
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    username: any(...)
  }
}

For Concur, use:

{
  type: 'Concur'
  typeProperties: {
    clientId: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
    username: any(...)
  }
}

For CosmosDb, use:

{
  type: 'CosmosDb'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For Couchbase, use:

{
  type: 'Couchbase'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For CustomDataSource, use:

{
  type: 'CustomDataSource'
  typeProperties: any(...)
}

For Db2, use:

{
  type: 'Db2'
  typeProperties: {
    authenticationType: 'string'
    database: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any(...)
    username: any(...)
  }
}

For Drill, use:

{
  type: 'Drill'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For Dynamics, use:

{
  type: 'Dynamics'
  typeProperties: {
    authenticationType: 'string'
    deploymentType: 'string'
    encryptedCredential: any(...)
    hostName: any(...)
    organizationName: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    serviceUri: any(...)
    username: any(...)
  }
}

For Eloqua, use:

{
  type: 'Eloqua'
  typeProperties: {
    encryptedCredential: any(...)
    endpoint: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
    username: any(...)
  }
}

For FileServer, use:

{
  type: 'FileServer'
  typeProperties: {
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userId: any(...)
  }
}

For FtpServer, use:

{
  type: 'FtpServer'
  typeProperties: {
    authenticationType: 'string'
    enableServerCertificateValidation: any(...)
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    userName: any(...)
  }
}

For GoogleBigQuery, use:

{
  type: 'GoogleBigQuery'
  typeProperties: {
    additionalProjects: any(...)
    authenticationType: 'string'
    clientId: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    email: any(...)
    encryptedCredential: any(...)
    keyFilePath: any(...)
    project: any(...)
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    requestGoogleDriveScope: any(...)
    trustedCertPath: any(...)
    useSystemTrustStore: any(...)
  }
}

For Greenplum, use:

{
  type: 'Greenplum'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For HBase, use:

{
  type: 'HBase'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    httpPath: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    trustedCertPath: any(...)
    username: any(...)
  }
}

For HDInsight, use:

{
  type: 'HDInsight'
  typeProperties: {
    clusterUri: any(...)
    encryptedCredential: any(...)
    hcatalogLinkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    linkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any(...)
  }
}

For HDInsightOnDemand, use:

{
  type: 'HDInsightOnDemand'
  typeProperties: {
    additionalLinkedServiceNames: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
    clusterNamePrefix: any(...)
    clusterPassword: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clusterResourceGroup: any(...)
    clusterSize: any(...)
    clusterSshPassword: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clusterSshUserName: any(...)
    clusterType: any(...)
    clusterUserName: any(...)
    coreConfiguration: any(...)
    dataNodeSize: any(...)
    encryptedCredential: any(...)
    hBaseConfiguration: any(...)
    hcatalogLinkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    hdfsConfiguration: any(...)
    headNodeSize: any(...)
    hiveConfiguration: any(...)
    hostSubscriptionId: any(...)
    linkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    mapReduceConfiguration: any(...)
    oozieConfiguration: any(...)
    servicePrincipalId: any(...)
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sparkVersion: any(...)
    stormConfiguration: any(...)
    tenant: any(...)
    timeToLive: any(...)
    version: any(...)
    yarnConfiguration: any(...)
    zookeeperNodeSize: any(...)
  }
}

For Hdfs, use:

{
  type: 'Hdfs'
  typeProperties: {
    authenticationType: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: any(...)
    userName: any(...)
  }
}

For Hive, use:

{
  type: 'Hive'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    httpPath: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    serverType: 'string'
    serviceDiscoveryMode: any(...)
    thriftTransportProtocol: 'string'
    trustedCertPath: any(...)
    useNativeQuery: any(...)
    username: any(...)
    useSystemTrustStore: any(...)
    zooKeeperNameSpace: any(...)
  }
}

For HttpServer, use:

{
  type: 'HttpServer'
  typeProperties: {
    authenticationType: 'string'
    certThumbprint: any(...)
    embeddedCertData: any(...)
    enableServerCertificateValidation: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: any(...)
    userName: any(...)
  }
}

For Hubspot, use:

{
  type: 'Hubspot'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Impala, use:

{
  type: 'Impala'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    trustedCertPath: any(...)
    username: any(...)
    useSystemTrustStore: any(...)
  }
}

For Jira, use:

{
  type: 'Jira'
  typeProperties: {
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
    username: any(...)
  }
}

For Magento, use:

{
  type: 'Magento'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    host: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For MariaDB, use:

{
  type: 'MariaDB'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For Marketo, use:

{
  type: 'Marketo'
  typeProperties: {
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    endpoint: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For MongoDb, use:

{
  type: 'MongoDb'
  typeProperties: {
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    authSource: any(...)
    databaseName: any(...)
    enableSsl: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    server: any(...)
    username: any(...)
  }
}

For MySql, use:

{
  type: 'MySql'
  typeProperties: {
    connectionString: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
  }
}

For Netezza, use:

{
  type: 'Netezza'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For OData, use:

{
  type: 'OData'
  typeProperties: {
    authenticationType: 'string'
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: any(...)
    userName: any(...)
  }
}

For Odbc, use:

{
  type: 'Odbc'
  typeProperties: {
    authenticationType: any(...)
    connectionString: any(...)
    credential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any(...)
  }
}

For Oracle, use:

{
  type: 'Oracle'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For Paypal, use:

{
  type: 'Paypal'
  typeProperties: {
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    host: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Phoenix, use:

{
  type: 'Phoenix'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    httpPath: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    trustedCertPath: any(...)
    username: any(...)
    useSystemTrustStore: any(...)
  }
}

For PostgreSql, use:

{
  type: 'PostgreSql'
  typeProperties: {
    connectionString: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
  }
}

For Presto, use:

{
  type: 'Presto'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    catalog: any(...)
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    serverVersion: any(...)
    timeZoneID: any(...)
    trustedCertPath: any(...)
    username: any(...)
    useSystemTrustStore: any(...)
  }
}

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(...)
    consumerKey: any(...)
    consumerSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    endpoint: any(...)
    useEncryptedEndpoints: any(...)
  }
}

For Responsys, use:

{
  type: 'Responsys'
  typeProperties: {
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    endpoint: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Salesforce, use:

{
  type: 'Salesforce'
  typeProperties: {
    encryptedCredential: any(...)
    environmentUrl: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    securityToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    username: any(...)
  }
}

For SalesforceMarketingCloud, use:

{
  type: 'SalesforceMarketingCloud'
  typeProperties: {
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For SapBW, use:

{
  type: 'SapBW'
  typeProperties: {
    clientId: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any(...)
    systemNumber: any(...)
    userName: any(...)
  }
}

For SapCloudForCustomer, use:

{
  type: 'SapCloudForCustomer'
  typeProperties: {
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: any(...)
    username: any(...)
  }
}

For SapEcc, use:

{
  type: 'SapEcc'
  typeProperties: {
    encryptedCredential: 'string'
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    url: 'string'
    username: 'string'
  }
}

For SapHana, use:

{
  type: 'SapHana'
  typeProperties: {
    authenticationType: 'string'
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any(...)
    userName: any(...)
  }
}

For ServiceNow, use:

{
  type: 'ServiceNow'
  typeProperties: {
    authenticationType: 'string'
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    endpoint: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
    username: any(...)
  }
}

For Sftp, use:

{
  type: 'Sftp'
  typeProperties: {
    authenticationType: 'string'
    encryptedCredential: any(...)
    host: any(...)
    hostKeyFingerprint: any(...)
    passPhrase: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    privateKeyContent: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    privateKeyPath: any(...)
    skipHostKeyValidation: any(...)
    userName: any(...)
  }
}

For Shopify, use:

{
  type: 'Shopify'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    host: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Spark, use:

{
  type: 'Spark'
  typeProperties: {
    allowHostNameCNMismatch: any(...)
    allowSelfSignedServerCert: any(...)
    authenticationType: 'string'
    enableSsl: any(...)
    encryptedCredential: any(...)
    host: any(...)
    httpPath: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any(...)
    serverType: 'string'
    thriftTransportProtocol: 'string'
    trustedCertPath: any(...)
    username: any(...)
    useSystemTrustStore: any(...)
  }
}

For SqlServer, use:

{
  type: 'SqlServer'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any(...)
  }
}

For Square, use:

{
  type: 'Square'
  typeProperties: {
    clientId: any(...)
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    host: any(...)
    redirectUri: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Sybase, use:

{
  type: 'Sybase'
  typeProperties: {
    authenticationType: 'string'
    database: any(...)
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    schema: any(...)
    server: any(...)
    username: any(...)
  }
}

For Teradata, use:

{
  type: 'Teradata'
  typeProperties: {
    authenticationType: 'string'
    encryptedCredential: any(...)
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any(...)
    username: any(...)
  }
}

For Vertica, use:

{
  type: 'Vertica'
  typeProperties: {
    connectionString: any(...)
    encryptedCredential: any(...)
  }
}

For Web, use:

{
  type: 'Web'
  typeProperties: {
    url: any(...)
    authenticationType: 'string'
    // For remaining properties, see WebLinkedServiceTypeProperties objects
  }
}

For Xero, use:

{
  type: 'Xero'
  typeProperties: {
    consumerKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    host: any(...)
    privateKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

For Zoho, use:

{
  type: 'Zoho'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: any(...)
    endpoint: any(...)
    useEncryptedEndpoints: any(...)
    useHostVerification: any(...)
    usePeerVerification: any(...)
  }
}

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

{
  secretName: any(...)
  secretVersion: any(...)
  store: {
    parameters: {
      {customized property}: any(...)
    }
    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(...)
}

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

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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
secretAccessKey	The secret access key of the Amazon S3 Identity and Access Management (IAM) user.	SecretBase

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
linkedServiceName	The Azure Storage linked service reference.	LinkedServiceReference (required)
poolName	The Azure Batch pool name. Type: string (or Expression with resultType string).	any (required)

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 (required)
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 (or Expression with resultType string).	any
existingClusterId	The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).	any
newClusterNodeType	The node types of new cluster. Type: string (or Expression with resultType string).	any
newClusterNumOfWorker	Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).	any
newClusterSparkConf	a set of optional, user-specified Spark configuration key-value pairs.	AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
newClusterVersion	The Spark version of new cluster. Type: string (or Expression with resultType string).	any

AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf

Name	Description	Value

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

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)

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)

AzureMLLinkedService

Name	Description	Value
type	Type of linked service.	'AzureML' (required)
typeProperties	Azure ML Web Service linked service properties.	AzureMLLinkedServiceTypeProperties (required)

AzureMLLinkedServiceTypeProperties

Name	Description	Value
apiKey	The API key for accessing the Azure ML model endpoint.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
mlEndpoint	The Batch Execution REST URL for an Azure ML 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 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 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 Web Service endpoint. 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 (or Expression with resultType string).	any

AzurePostgreSqlLinkedService

Name	Description	Value
type	Type of linked service.	'AzurePostgreSql' (required)
typeProperties	Azure PostgreSQL linked service properties.	AzurePostgreSqlLinkedServiceTypeProperties (required)

AzurePostgreSqlLinkedServiceTypeProperties

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

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
connectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. 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 (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

AzureStorageLinkedService

Name	Description	Value
type	Type of linked service.	'AzureStorage' (required)
typeProperties	Azure Storage linked service properties.	AzureStorageLinkedServiceTypeProperties (required)

AzureStorageLinkedServiceTypeProperties

Name	Description	Value
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 (or Expression with resultType string).	any
sasUri	SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.	SecretBase

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

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (or Expression with resultType string).	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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

CustomDataSourceLinkedService

Name	Description	Value
type	Type of linked service.	'CustomDataSource' (required)
typeProperties	Custom linked service properties.	any (required)

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.	'Basic'
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 (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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 (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. Type: string (or Expression with resultType string).	'Ifd' 'Office365' (required)
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).	'Online' 'OnPremisesWithIfd' (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (required)

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

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.	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.	SecretBase
clientSecret	The client secret of the google application used to acquire the refresh token.	SecretBase
email	The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.	any
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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.	any
project	The default BigQuery project to query against.	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.	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
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

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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
hcatalogLinkedServiceName	A reference to the Azure SQL linked service that points to the HCatalog database.	LinkedServiceReference
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: string (or Expression with resultType string).	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
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 (or Expression with resultType string).	any
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
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
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)
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 (or Expression with resultType string).	any
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'
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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

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

LinkedService

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	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 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. 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 'AzureStorage' for type AzureStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. 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 'Jira' for type JiraLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. 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 'Oracle' for type OracleLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. 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 'ServiceNow' for type ServiceNowLinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'Shopify' for type ShopifyLinkedService. 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 'Teradata' for type TeradataLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zoho' for type ZohoLinkedService.	'AmazonMWS' 'AmazonRedshift' 'AmazonS3' 'AzureBatch' 'AzureDatabricks' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureKeyVault' 'AzureML' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureStorage' 'Cassandra' 'Concur' 'CosmosDb' 'Couchbase' 'CustomDataSource' 'Db2' 'Drill' 'Dynamics' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleBigQuery' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Jira' 'Magento' 'MariaDB' 'Marketo' 'MongoDb' 'MySql' 'Netezza' 'OData' 'Odbc' 'Oracle' 'Paypal' 'Phoenix' 'PostgreSql' 'Presto' 'QuickBooks' 'Responsys' 'Salesforce' 'SalesforceMarketingCloud' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'ServiceNow' 'Sftp' 'Shopify' 'Spark' 'SqlServer' 'Square' 'Sybase' 'Teradata' 'Vertica' 'Web' 'Xero' 'Zoho' (required)

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 (or Expression with resultType string).	any
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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any
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 = 260 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)

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

MySqlLinkedService

Name	Description	Value
type	Type of linked service.	'MySql' (required)
typeProperties	MySQL linked service properties.	MySqlLinkedServiceTypeProperties (required)

MySqlLinkedServiceTypeProperties

Name	Description	Value
connectionString	The connection string.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any

ODataLinkedService

Name	Description	Value
type	Type of linked service.	'OData' (required)
typeProperties	OData linked service properties.	ODataLinkedServiceTypeProperties (required)

ODataLinkedServiceTypeProperties

Name	Description	Value
authenticationType	Type of authentication used to connect to the OData service.	'Anonymous' 'Basic'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password of the OData service.	SecretBase
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, SecureString or AzureKeyVaultSecretReference.	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 (or Expression with resultType string).	any
password	Password for Basic authentication.	SecretBase
userName	User name for Basic authentication. 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 (or Expression with resultType string).	any

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

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

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 (required)
accessTokenSecret	The access token secret for OAuth 1.0 authentication.	SecretBase (required)
companyId	The company ID of the QuickBooks company to authorize.	any (required)
consumerKey	The consumer key for OAuth 1.0 authentication.	any (required)
consumerSecret	The consumer secret for OAuth 1.0 authentication.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)	any (required)
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 (or Expression with resultType string).	any
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

SalesforceLinkedService

Name	Description	Value
type	Type of linked service.	'Salesforce' (required)
typeProperties	Salesforce linked service properties.	SalesforceLinkedServiceTypeProperties (required)

SalesforceLinkedServiceTypeProperties

Name	Description	Value
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 required 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 (required)
clientSecret	The client secret associated with the Salesforce Marketing Cloud 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 (or Expression with resultType string).	any
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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType 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).	string (required)
username	The username for Basic authentication. Type: string (or Expression with resultType string).	string

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 (required)
userName	Username to access the SAP HANA server. Type: string (or Expression with resultType string).	any

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

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' 'SshPublicKey'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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

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

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

SqlServerLinkedService

Name	Description	Value
type	Type of linked service.	'SqlServer' (required)
typeProperties	SQL Server linked service properties.	SqlServerLinkedServiceTypeProperties (required)

SqlServerLinkedServiceTypeProperties

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 (or Expression with resultType string).	any
password	The on-premises Windows authentication password.	SecretBase
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 (required)
clientSecret	The client secret associated with your Square application.	SecretBase
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
host	The URL of the Square instance. (i.e. mystore.mysquare.com)	any (required)
redirectUri	The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)	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

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

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. 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
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 (or Expression with resultType string).	any
host	The endpoint of the Xero server. (i.e. api.xero.com)	any (required)
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)	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

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "annotations": [ {} ],
    "connectVia": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "description": "string",
    "parameters": {
      "{customized property}": {
        "defaultValue": {},
        "type": "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": {},
    "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 AmazonRedshift, use:

{
  "type": "AmazonRedshift",
  "typeProperties": {
    "database": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "server": {},
    "username": {}
  }
}

For AmazonS3, use:

{
  "type": "AmazonS3",
  "typeProperties": {
    "accessKeyId": {},
    "encryptedCredential": {},
    "secretAccessKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

For AzureBatch, use:

{
  "type": "AzureBatch",
  "typeProperties": {
    "accessKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "accountName": {},
    "batchUri": {},
    "encryptedCredential": {},
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "poolName": {}
  }
}

For AzureDataLakeAnalytics, use:

{
  "type": "AzureDataLakeAnalytics",
  "typeProperties": {
    "accountName": {},
    "dataLakeAnalyticsUri": {},
    "encryptedCredential": {},
    "resourceGroupName": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "subscriptionId": {},
    "tenant": {}
  }
}

For AzureDataLakeStore, use:

{
  "type": "AzureDataLakeStore",
  "typeProperties": {
    "accountName": {},
    "dataLakeStoreUri": {},
    "encryptedCredential": {},
    "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
    },
    "domain": {},
    "encryptedCredential": {},
    "existingClusterId": {},
    "newClusterNodeType": {},
    "newClusterNumOfWorker": {},
    "newClusterSparkConf": {
      "{customized property}": {}
    },
    "newClusterVersion": {}
  }
}

For AzureKeyVault, use:

{
  "type": "AzureKeyVault",
  "typeProperties": {
    "baseUrl": {}
  }
}

For AzureML, use:

{
  "type": "AzureML",
  "typeProperties": {
    "apiKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "mlEndpoint": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "updateResourceEndpoint": {}
  }
}

For AzureMySql, use:

{
  "type": "AzureMySql",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For AzurePostgreSql, use:

{
  "type": "AzurePostgreSql",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For AzureSearch, use:

{
  "type": "AzureSearch",
  "typeProperties": {
    "encryptedCredential": {},
    "key": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "url": {}
  }
}

For AzureSqlDW, use:

{
  "type": "AzureSqlDW",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }
}

For AzureSqlDatabase, use:

{
  "type": "AzureSqlDatabase",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }
}

For AzureStorage, use:

{
  "type": "AzureStorage",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {},
    "sasUri": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

For Cassandra, use:

{
  "type": "Cassandra",
  "typeProperties": {
    "authenticationType": {},
    "encryptedCredential": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "username": {}
  }
}

For Concur, use:

{
  "type": "Concur",
  "typeProperties": {
    "clientId": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {},
    "username": {}
  }
}

For CosmosDb, use:

{
  "type": "CosmosDb",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For Couchbase, use:

{
  "type": "Couchbase",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For CustomDataSource, use:

{
  "type": "CustomDataSource",
  "typeProperties": {}
}

For Db2, use:

{
  "type": "Db2",
  "typeProperties": {
    "authenticationType": "string",
    "database": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "username": {}
  }
}

For Drill, use:

{
  "type": "Drill",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For Dynamics, use:

{
  "type": "Dynamics",
  "typeProperties": {
    "authenticationType": "string",
    "deploymentType": "string",
    "encryptedCredential": {},
    "hostName": {},
    "organizationName": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "serviceUri": {},
    "username": {}
  }
}

For Eloqua, use:

{
  "type": "Eloqua",
  "typeProperties": {
    "encryptedCredential": {},
    "endpoint": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {},
    "username": {}
  }
}

For FileServer, use:

{
  "type": "FileServer",
  "typeProperties": {
    "encryptedCredential": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userId": {}
  }
}

For FtpServer, use:

{
  "type": "FtpServer",
  "typeProperties": {
    "authenticationType": "string",
    "enableServerCertificateValidation": {},
    "enableSsl": {},
    "encryptedCredential": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "userName": {}
  }
}

For GoogleBigQuery, use:

{
  "type": "GoogleBigQuery",
  "typeProperties": {
    "additionalProjects": {},
    "authenticationType": "string",
    "clientId": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "email": {},
    "encryptedCredential": {},
    "keyFilePath": {},
    "project": {},
    "refreshToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "requestGoogleDriveScope": {},
    "trustedCertPath": {},
    "useSystemTrustStore": {}
  }
}

For Greenplum, use:

{
  "type": "Greenplum",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For HBase, use:

{
  "type": "HBase",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "enableSsl": {},
    "encryptedCredential": {},
    "host": {},
    "httpPath": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "trustedCertPath": {},
    "username": {}
  }
}

For HDInsight, use:

{
  "type": "HDInsight",
  "typeProperties": {
    "clusterUri": {},
    "encryptedCredential": {},
    "hcatalogLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "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": {},
    "dataNodeSize": {},
    "encryptedCredential": {},
    "hBaseConfiguration": {},
    "hcatalogLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "hdfsConfiguration": {},
    "headNodeSize": {},
    "hiveConfiguration": {},
    "hostSubscriptionId": {},
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "mapReduceConfiguration": {},
    "oozieConfiguration": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "sparkVersion": {},
    "stormConfiguration": {},
    "tenant": {},
    "timeToLive": {},
    "version": {},
    "yarnConfiguration": {},
    "zookeeperNodeSize": {}
  }
}

For Hdfs, use:

{
  "type": "Hdfs",
  "typeProperties": {
    "authenticationType": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "url": {},
    "userName": {}
  }
}

For Hive, use:

{
  "type": "Hive",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "enableSsl": {},
    "encryptedCredential": {},
    "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",
    "certThumbprint": {},
    "embeddedCertData": {},
    "enableServerCertificateValidation": {},
    "encryptedCredential": {},
    "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": {},
    "refreshToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Impala, use:

{
  "type": "Impala",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "enableSsl": {},
    "encryptedCredential": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "trustedCertPath": {},
    "username": {},
    "useSystemTrustStore": {}
  }
}

For Jira, use:

{
  "type": "Jira",
  "typeProperties": {
    "encryptedCredential": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {},
    "username": {}
  }
}

For Magento, use:

{
  "type": "Magento",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "host": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For MariaDB, use:

{
  "type": "MariaDB",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For Marketo, use:

{
  "type": "Marketo",
  "typeProperties": {
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "endpoint": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For MongoDb, use:

{
  "type": "MongoDb",
  "typeProperties": {
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "authSource": {},
    "databaseName": {},
    "enableSsl": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "server": {},
    "username": {}
  }
}

For MySql, use:

{
  "type": "MySql",
  "typeProperties": {
    "connectionString": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {}
  }
}

For Netezza, use:

{
  "type": "Netezza",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For OData, use:

{
  "type": "OData",
  "typeProperties": {
    "authenticationType": "string",
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "url": {},
    "userName": {}
  }
}

For Odbc, use:

{
  "type": "Odbc",
  "typeProperties": {
    "authenticationType": {},
    "connectionString": {},
    "credential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }
}

For Oracle, use:

{
  "type": "Oracle",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For Paypal, use:

{
  "type": "Paypal",
  "typeProperties": {
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "host": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Phoenix, use:

{
  "type": "Phoenix",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "enableSsl": {},
    "encryptedCredential": {},
    "host": {},
    "httpPath": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "trustedCertPath": {},
    "username": {},
    "useSystemTrustStore": {}
  }
}

For PostgreSql, use:

{
  "type": "PostgreSql",
  "typeProperties": {
    "connectionString": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {}
  }
}

For Presto, use:

{
  "type": "Presto",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "catalog": {},
    "enableSsl": {},
    "encryptedCredential": {},
    "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": {},
    "consumerKey": {},
    "consumerSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "endpoint": {},
    "useEncryptedEndpoints": {}
  }
}

For Responsys, use:

{
  "type": "Responsys",
  "typeProperties": {
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "endpoint": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Salesforce, use:

{
  "type": "Salesforce",
  "typeProperties": {
    "encryptedCredential": {},
    "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
    },
    "encryptedCredential": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For SapBW, use:

{
  "type": "SapBW",
  "typeProperties": {
    "clientId": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "systemNumber": {},
    "userName": {}
  }
}

For SapCloudForCustomer, use:

{
  "type": "SapCloudForCustomer",
  "typeProperties": {
    "encryptedCredential": {},
    "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": "string",
    "username": "string"
  }
}

For SapHana, use:

{
  "type": "SapHana",
  "typeProperties": {
    "authenticationType": "string",
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "userName": {}
  }
}

For ServiceNow, use:

{
  "type": "ServiceNow",
  "typeProperties": {
    "authenticationType": "string",
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "endpoint": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {},
    "username": {}
  }
}

For Sftp, use:

{
  "type": "Sftp",
  "typeProperties": {
    "authenticationType": "string",
    "encryptedCredential": {},
    "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 Shopify, use:

{
  "type": "Shopify",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "host": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Spark, use:

{
  "type": "Spark",
  "typeProperties": {
    "allowHostNameCNMismatch": {},
    "allowSelfSignedServerCert": {},
    "authenticationType": "string",
    "enableSsl": {},
    "encryptedCredential": {},
    "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": {
    "connectionString": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }
}

For Square, use:

{
  "type": "Square",
  "typeProperties": {
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "host": {},
    "redirectUri": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Sybase, use:

{
  "type": "Sybase",
  "typeProperties": {
    "authenticationType": "string",
    "database": {},
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "schema": {},
    "server": {},
    "username": {}
  }
}

For Teradata, use:

{
  "type": "Teradata",
  "typeProperties": {
    "authenticationType": "string",
    "encryptedCredential": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "username": {}
  }
}

For Vertica, use:

{
  "type": "Vertica",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": {}
  }
}

For Web, use:

{
  "type": "Web",
  "typeProperties": {
    "url": {},
    "authenticationType": "string"
    // For remaining properties, see WebLinkedServiceTypeProperties objects
  }
}

For Xero, use:

{
  "type": "Xero",
  "typeProperties": {
    "consumerKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "host": {},
    "privateKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }
}

For Zoho, use:

{
  "type": "Zoho",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": {},
    "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 (or Expression with resultType string).	any
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

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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
secretAccessKey	The secret access key of the Amazon S3 Identity and Access Management (IAM) user.	SecretBase

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
linkedServiceName	The Azure Storage linked service reference.	LinkedServiceReference (required)
poolName	The Azure Batch pool name. Type: string (or Expression with resultType string).	any (required)

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 (required)
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 (or Expression with resultType string).	any
existingClusterId	The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).	any
newClusterNodeType	The node types of new cluster. Type: string (or Expression with resultType string).	any
newClusterNumOfWorker	Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).	any
newClusterSparkConf	a set of optional, user-specified Spark configuration key-value pairs.	AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
newClusterVersion	The Spark version of new cluster. Type: string (or Expression with resultType string).	any

AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf

Name	Description	Value

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

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)

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)

AzureMLLinkedService

Name	Description	Value
type	Type of linked service.	'AzureML' (required)
typeProperties	Azure ML Web Service linked service properties.	AzureMLLinkedServiceTypeProperties (required)

AzureMLLinkedServiceTypeProperties

Name	Description	Value
apiKey	The API key for accessing the Azure ML model endpoint.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
mlEndpoint	The Batch Execution REST URL for an Azure ML 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 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 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 Web Service endpoint. 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 (or Expression with resultType string).	any

AzurePostgreSqlLinkedService

Name	Description	Value
type	Type of linked service.	'AzurePostgreSql' (required)
typeProperties	Azure PostgreSQL linked service properties.	AzurePostgreSqlLinkedServiceTypeProperties (required)

AzurePostgreSqlLinkedServiceTypeProperties

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

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
connectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. 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 (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

AzureStorageLinkedService

Name	Description	Value
type	Type of linked service.	'AzureStorage' (required)
typeProperties	Azure Storage linked service properties.	AzureStorageLinkedServiceTypeProperties (required)

AzureStorageLinkedServiceTypeProperties

Name	Description	Value
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 (or Expression with resultType string).	any
sasUri	SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.	SecretBase

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

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (or Expression with resultType string).	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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

CustomDataSourceLinkedService

Name	Description	Value
type	Type of linked service.	'CustomDataSource' (required)
typeProperties	Custom linked service properties.	any (required)

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.	'Basic'
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 (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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 (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. Type: string (or Expression with resultType string).	'Ifd' 'Office365' (required)
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).	'Online' 'OnPremisesWithIfd' (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (required)

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

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.	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.	SecretBase
clientSecret	The client secret of the google application used to acquire the refresh token.	SecretBase
email	The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.	any
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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.	any
project	The default BigQuery project to query against.	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.	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
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

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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
hcatalogLinkedServiceName	A reference to the Azure SQL linked service that points to the HCatalog database.	LinkedServiceReference
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: string (or Expression with resultType string).	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
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 (or Expression with resultType string).	any
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
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
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)
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 (or Expression with resultType string).	any
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'
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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

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

LinkedService

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	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 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. 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 'AzureStorage' for type AzureStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. 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 'Jira' for type JiraLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. 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 'Oracle' for type OracleLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. 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 'ServiceNow' for type ServiceNowLinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'Shopify' for type ShopifyLinkedService. 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 'Teradata' for type TeradataLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zoho' for type ZohoLinkedService.	'AmazonMWS' 'AmazonRedshift' 'AmazonS3' 'AzureBatch' 'AzureDatabricks' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureKeyVault' 'AzureML' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureStorage' 'Cassandra' 'Concur' 'CosmosDb' 'Couchbase' 'CustomDataSource' 'Db2' 'Drill' 'Dynamics' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleBigQuery' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Jira' 'Magento' 'MariaDB' 'Marketo' 'MongoDb' 'MySql' 'Netezza' 'OData' 'Odbc' 'Oracle' 'Paypal' 'Phoenix' 'PostgreSql' 'Presto' 'QuickBooks' 'Responsys' 'Salesforce' 'SalesforceMarketingCloud' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'ServiceNow' 'Sftp' 'Shopify' 'Spark' 'SqlServer' 'Square' 'Sybase' 'Teradata' 'Vertica' 'Web' 'Xero' 'Zoho' (required)

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 (or Expression with resultType string).	any
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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any
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	'2017-09-01-preview'
name	The resource name	string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
properties	Properties of linked service.	LinkedService (required)
type	The resource type	'Microsoft.DataFactory/factories/linkedservices'

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

MySqlLinkedService

Name	Description	Value
type	Type of linked service.	'MySql' (required)
typeProperties	MySQL linked service properties.	MySqlLinkedServiceTypeProperties (required)

MySqlLinkedServiceTypeProperties

Name	Description	Value
connectionString	The connection string.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any

ODataLinkedService

Name	Description	Value
type	Type of linked service.	'OData' (required)
typeProperties	OData linked service properties.	ODataLinkedServiceTypeProperties (required)

ODataLinkedServiceTypeProperties

Name	Description	Value
authenticationType	Type of authentication used to connect to the OData service.	'Anonymous' 'Basic'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password of the OData service.	SecretBase
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, SecureString or AzureKeyVaultSecretReference.	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 (or Expression with resultType string).	any
password	Password for Basic authentication.	SecretBase
userName	User name for Basic authentication. 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 (or Expression with resultType string).	any

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

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

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 (required)
accessTokenSecret	The access token secret for OAuth 1.0 authentication.	SecretBase (required)
companyId	The company ID of the QuickBooks company to authorize.	any (required)
consumerKey	The consumer key for OAuth 1.0 authentication.	any (required)
consumerSecret	The consumer secret for OAuth 1.0 authentication.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)	any (required)
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 (or Expression with resultType string).	any
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

SalesforceLinkedService

Name	Description	Value
type	Type of linked service.	'Salesforce' (required)
typeProperties	Salesforce linked service properties.	SalesforceLinkedServiceTypeProperties (required)

SalesforceLinkedServiceTypeProperties

Name	Description	Value
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 required 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 (required)
clientSecret	The client secret associated with the Salesforce Marketing Cloud 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 (or Expression with resultType string).	any
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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType 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).	string (required)
username	The username for Basic authentication. Type: string (or Expression with resultType string).	string

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 (required)
userName	Username to access the SAP HANA server. Type: string (or Expression with resultType string).	any

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

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' 'SshPublicKey'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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

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

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

SqlServerLinkedService

Name	Description	Value
type	Type of linked service.	'SqlServer' (required)
typeProperties	SQL Server linked service properties.	SqlServerLinkedServiceTypeProperties (required)

SqlServerLinkedServiceTypeProperties

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 (or Expression with resultType string).	any
password	The on-premises Windows authentication password.	SecretBase
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 (required)
clientSecret	The client secret associated with your Square application.	SecretBase
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
host	The URL of the Square instance. (i.e. mystore.mysquare.com)	any (required)
redirectUri	The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)	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

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

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. 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
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 (or Expression with resultType string).	any
host	The endpoint of the Xero server. (i.e. api.xero.com)	any (required)
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)	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

Usage Examples

Azure Quickstart Templates

The following Azure 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@2017-09-01-preview"
  name = "string"
  body = {
    properties = {
      annotations = [
        ?
      ]
      connectVia = {
        parameters = {
          {customized property} = ?
        }
        referenceName = "string"
        type = "string"
      }
      description = "string"
      parameters = {
        {customized property} = {
          defaultValue = ?
          type = "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 = ?
    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 AmazonRedshift, use:

{
  type = "AmazonRedshift"
  typeProperties = {
    database = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    server = ?
    username = ?
  }
}

For AmazonS3, use:

{
  type = "AmazonS3"
  typeProperties = {
    accessKeyId = ?
    encryptedCredential = ?
    secretAccessKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

For AzureBatch, use:

{
  type = "AzureBatch"
  typeProperties = {
    accessKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    accountName = ?
    batchUri = ?
    encryptedCredential = ?
    linkedServiceName = {
      parameters = {
        {customized property} = ?
      }
      referenceName = "string"
      type = "string"
    }
    poolName = ?
  }
}

For AzureDataLakeAnalytics, use:

{
  type = "AzureDataLakeAnalytics"
  typeProperties = {
    accountName = ?
    dataLakeAnalyticsUri = ?
    encryptedCredential = ?
    resourceGroupName = ?
    servicePrincipalId = ?
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    subscriptionId = ?
    tenant = ?
  }
}

For AzureDataLakeStore, use:

{
  type = "AzureDataLakeStore"
  typeProperties = {
    accountName = ?
    dataLakeStoreUri = ?
    encryptedCredential = ?
    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
    }
    domain = ?
    encryptedCredential = ?
    existingClusterId = ?
    newClusterNodeType = ?
    newClusterNumOfWorker = ?
    newClusterSparkConf = {
      {customized property} = ?
    }
    newClusterVersion = ?
  }
}

For AzureKeyVault, use:

{
  type = "AzureKeyVault"
  typeProperties = {
    baseUrl = ?
  }
}

For AzureML, use:

{
  type = "AzureML"
  typeProperties = {
    apiKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    mlEndpoint = ?
    servicePrincipalId = ?
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    tenant = ?
    updateResourceEndpoint = ?
  }
}

For AzureMySql, use:

{
  type = "AzureMySql"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For AzurePostgreSql, use:

{
  type = "AzurePostgreSql"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For AzureSearch, use:

{
  type = "AzureSearch"
  typeProperties = {
    encryptedCredential = ?
    key = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    url = ?
  }
}

For AzureSqlDW, use:

{
  type = "AzureSqlDW"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
    servicePrincipalId = ?
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    tenant = ?
  }
}

For AzureSqlDatabase, use:

{
  type = "AzureSqlDatabase"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
    servicePrincipalId = ?
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    tenant = ?
  }
}

For AzureStorage, use:

{
  type = "AzureStorage"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
    sasUri = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

For Cassandra, use:

{
  type = "Cassandra"
  typeProperties = {
    authenticationType = ?
    encryptedCredential = ?
    host = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    username = ?
  }
}

For Concur, use:

{
  type = "Concur"
  typeProperties = {
    clientId = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
    username = ?
  }
}

For CosmosDb, use:

{
  type = "CosmosDb"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For Couchbase, use:

{
  type = "Couchbase"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For CustomDataSource, use:

{
  type = "CustomDataSource"
  typeProperties = ?
}

For Db2, use:

{
  type = "Db2"
  typeProperties = {
    authenticationType = "string"
    database = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    server = ?
    username = ?
  }
}

For Drill, use:

{
  type = "Drill"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For Dynamics, use:

{
  type = "Dynamics"
  typeProperties = {
    authenticationType = "string"
    deploymentType = "string"
    encryptedCredential = ?
    hostName = ?
    organizationName = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    serviceUri = ?
    username = ?
  }
}

For Eloqua, use:

{
  type = "Eloqua"
  typeProperties = {
    encryptedCredential = ?
    endpoint = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
    username = ?
  }
}

For FileServer, use:

{
  type = "FileServer"
  typeProperties = {
    encryptedCredential = ?
    host = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    userId = ?
  }
}

For FtpServer, use:

{
  type = "FtpServer"
  typeProperties = {
    authenticationType = "string"
    enableServerCertificateValidation = ?
    enableSsl = ?
    encryptedCredential = ?
    host = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    userName = ?
  }
}

For GoogleBigQuery, use:

{
  type = "GoogleBigQuery"
  typeProperties = {
    additionalProjects = ?
    authenticationType = "string"
    clientId = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    email = ?
    encryptedCredential = ?
    keyFilePath = ?
    project = ?
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    requestGoogleDriveScope = ?
    trustedCertPath = ?
    useSystemTrustStore = ?
  }
}

For Greenplum, use:

{
  type = "Greenplum"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For HBase, use:

{
  type = "HBase"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    enableSsl = ?
    encryptedCredential = ?
    host = ?
    httpPath = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    trustedCertPath = ?
    username = ?
  }
}

For HDInsight, use:

{
  type = "HDInsight"
  typeProperties = {
    clusterUri = ?
    encryptedCredential = ?
    hcatalogLinkedServiceName = {
      parameters = {
        {customized property} = ?
      }
      referenceName = "string"
      type = "string"
    }
    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 = ?
    dataNodeSize = ?
    encryptedCredential = ?
    hBaseConfiguration = ?
    hcatalogLinkedServiceName = {
      parameters = {
        {customized property} = ?
      }
      referenceName = "string"
      type = "string"
    }
    hdfsConfiguration = ?
    headNodeSize = ?
    hiveConfiguration = ?
    hostSubscriptionId = ?
    linkedServiceName = {
      parameters = {
        {customized property} = ?
      }
      referenceName = "string"
      type = "string"
    }
    mapReduceConfiguration = ?
    oozieConfiguration = ?
    servicePrincipalId = ?
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    sparkVersion = ?
    stormConfiguration = ?
    tenant = ?
    timeToLive = ?
    version = ?
    yarnConfiguration = ?
    zookeeperNodeSize = ?
  }
}

For Hdfs, use:

{
  type = "Hdfs"
  typeProperties = {
    authenticationType = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    url = ?
    userName = ?
  }
}

For Hive, use:

{
  type = "Hive"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    enableSsl = ?
    encryptedCredential = ?
    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"
    certThumbprint = ?
    embeddedCertData = ?
    enableServerCertificateValidation = ?
    encryptedCredential = ?
    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 = ?
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Impala, use:

{
  type = "Impala"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    enableSsl = ?
    encryptedCredential = ?
    host = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    trustedCertPath = ?
    username = ?
    useSystemTrustStore = ?
  }
}

For Jira, use:

{
  type = "Jira"
  typeProperties = {
    encryptedCredential = ?
    host = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
    username = ?
  }
}

For Magento, use:

{
  type = "Magento"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    host = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For MariaDB, use:

{
  type = "MariaDB"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For Marketo, use:

{
  type = "Marketo"
  typeProperties = {
    clientId = ?
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    endpoint = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For MongoDb, use:

{
  type = "MongoDb"
  typeProperties = {
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    authSource = ?
    databaseName = ?
    enableSsl = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    server = ?
    username = ?
  }
}

For MySql, use:

{
  type = "MySql"
  typeProperties = {
    connectionString = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
  }
}

For Netezza, use:

{
  type = "Netezza"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For OData, use:

{
  type = "OData"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    url = ?
    userName = ?
  }
}

For Odbc, use:

{
  type = "Odbc"
  typeProperties = {
    authenticationType = ?
    connectionString = ?
    credential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    userName = ?
  }
}

For Oracle, use:

{
  type = "Oracle"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For Paypal, use:

{
  type = "Paypal"
  typeProperties = {
    clientId = ?
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    host = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Phoenix, use:

{
  type = "Phoenix"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    enableSsl = ?
    encryptedCredential = ?
    host = ?
    httpPath = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    port = ?
    trustedCertPath = ?
    username = ?
    useSystemTrustStore = ?
  }
}

For PostgreSql, use:

{
  type = "PostgreSql"
  typeProperties = {
    connectionString = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
  }
}

For Presto, use:

{
  type = "Presto"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    catalog = ?
    enableSsl = ?
    encryptedCredential = ?
    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 = ?
    consumerKey = ?
    consumerSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    endpoint = ?
    useEncryptedEndpoints = ?
  }
}

For Responsys, use:

{
  type = "Responsys"
  typeProperties = {
    clientId = ?
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    endpoint = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Salesforce, use:

{
  type = "Salesforce"
  typeProperties = {
    encryptedCredential = ?
    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
    }
    encryptedCredential = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For SapBW, use:

{
  type = "SapBW"
  typeProperties = {
    clientId = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    server = ?
    systemNumber = ?
    userName = ?
  }
}

For SapCloudForCustomer, use:

{
  type = "SapCloudForCustomer"
  typeProperties = {
    encryptedCredential = ?
    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 = "string"
    username = "string"
  }
}

For SapHana, use:

{
  type = "SapHana"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    server = ?
    userName = ?
  }
}

For ServiceNow, use:

{
  type = "ServiceNow"
  typeProperties = {
    authenticationType = "string"
    clientId = ?
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    endpoint = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
    username = ?
  }
}

For Sftp, use:

{
  type = "Sftp"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = ?
    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 Shopify, use:

{
  type = "Shopify"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    host = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Spark, use:

{
  type = "Spark"
  typeProperties = {
    allowHostNameCNMismatch = ?
    allowSelfSignedServerCert = ?
    authenticationType = "string"
    enableSsl = ?
    encryptedCredential = ?
    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 = {
    connectionString = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    userName = ?
  }
}

For Square, use:

{
  type = "Square"
  typeProperties = {
    clientId = ?
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    host = ?
    redirectUri = ?
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Sybase, use:

{
  type = "Sybase"
  typeProperties = {
    authenticationType = "string"
    database = ?
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    schema = ?
    server = ?
    username = ?
  }
}

For Teradata, use:

{
  type = "Teradata"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = ?
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    server = ?
    username = ?
  }
}

For Vertica, use:

{
  type = "Vertica"
  typeProperties = {
    connectionString = ?
    encryptedCredential = ?
  }
}

For Web, use:

{
  type = "Web"
  typeProperties = {
    url = ?
    authenticationType = "string"
    // For remaining properties, see WebLinkedServiceTypeProperties objects
  }
}

For Xero, use:

{
  type = "Xero"
  typeProperties = {
    consumerKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    host = ?
    privateKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints = ?
    useHostVerification = ?
    usePeerVerification = ?
  }
}

For Zoho, use:

{
  type = "Zoho"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = ?
    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 (or Expression with resultType string).	any
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

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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
secretAccessKey	The secret access key of the Amazon S3 Identity and Access Management (IAM) user.	SecretBase

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
linkedServiceName	The Azure Storage linked service reference.	LinkedServiceReference (required)
poolName	The Azure Batch pool name. Type: string (or Expression with resultType string).	any (required)

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 (required)
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 (or Expression with resultType string).	any
existingClusterId	The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).	any
newClusterNodeType	The node types of new cluster. Type: string (or Expression with resultType string).	any
newClusterNumOfWorker	Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).	any
newClusterSparkConf	a set of optional, user-specified Spark configuration key-value pairs.	AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf
newClusterVersion	The Spark version of new cluster. Type: string (or Expression with resultType string).	any

AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf

Name	Description	Value

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

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)

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)

AzureMLLinkedService

Name	Description	Value
type	Type of linked service.	'AzureML' (required)
typeProperties	Azure ML Web Service linked service properties.	AzureMLLinkedServiceTypeProperties (required)

AzureMLLinkedServiceTypeProperties

Name	Description	Value
apiKey	The API key for accessing the Azure ML model endpoint.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
mlEndpoint	The Batch Execution REST URL for an Azure ML 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 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 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 Web Service endpoint. 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 (or Expression with resultType string).	any

AzurePostgreSqlLinkedService

Name	Description	Value
type	Type of linked service.	'AzurePostgreSql' (required)
typeProperties	Azure PostgreSQL linked service properties.	AzurePostgreSqlLinkedServiceTypeProperties (required)

AzurePostgreSqlLinkedServiceTypeProperties

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

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
connectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. 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 (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

AzureStorageLinkedService

Name	Description	Value
type	Type of linked service.	'AzureStorage' (required)
typeProperties	Azure Storage linked service properties.	AzureStorageLinkedServiceTypeProperties (required)

AzureStorageLinkedServiceTypeProperties

Name	Description	Value
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 (or Expression with resultType string).	any
sasUri	SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.	SecretBase

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

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)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (or Expression with resultType string).	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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

CustomDataSourceLinkedService

Name	Description	Value
type	Type of linked service.	'CustomDataSource' (required)
typeProperties	Custom linked service properties.	any (required)

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.	'Basic'
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 (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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 (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. Type: string (or Expression with resultType string).	'Ifd' 'Office365' (required)
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).	'Online' 'OnPremisesWithIfd' (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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
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 (required)

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

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.	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.	SecretBase
clientSecret	The client secret of the google application used to acquire the refresh token.	SecretBase
email	The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.	any
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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.	any
project	The default BigQuery project to query against.	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.	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
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

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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
hcatalogLinkedServiceName	A reference to the Azure SQL linked service that points to the HCatalog database.	LinkedServiceReference
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: string (or Expression with resultType string).	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
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 (or Expression with resultType string).	any
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
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
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)
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 (or Expression with resultType string).	any
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'
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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

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

LinkedService

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	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 'AmazonRedshift' for type AmazonRedshiftLinkedService. Set to 'AmazonS3' for type AmazonS3LinkedService. Set to 'AzureBatch' for type AzureBatchLinkedService. Set to 'AzureDataLakeAnalytics' for type AzureDataLakeAnalyticsLinkedService. Set to 'AzureDataLakeStore' for type AzureDataLakeStoreLinkedService. Set to 'AzureDatabricks' for type AzureDatabricksLinkedService. Set to 'AzureKeyVault' for type AzureKeyVaultLinkedService. Set to 'AzureML' for type AzureMLLinkedService. 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 'AzureStorage' for type AzureStorageLinkedService. Set to 'Cassandra' for type CassandraLinkedService. Set to 'Concur' for type ConcurLinkedService. Set to 'CosmosDb' for type CosmosDbLinkedService. Set to 'Couchbase' for type CouchbaseLinkedService. Set to 'CustomDataSource' for type CustomDataSourceLinkedService. Set to 'Db2' for type Db2LinkedService. Set to 'Drill' for type DrillLinkedService. Set to 'Dynamics' for type DynamicsLinkedService. Set to 'Eloqua' for type EloquaLinkedService. Set to 'FileServer' for type FileServerLinkedService. Set to 'FtpServer' for type FtpServerLinkedService. Set to 'GoogleBigQuery' for type GoogleBigQueryLinkedService. 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 'Jira' for type JiraLinkedService. Set to 'Magento' for type MagentoLinkedService. Set to 'MariaDB' for type MariaDBLinkedService. Set to 'Marketo' for type MarketoLinkedService. Set to 'MongoDb' for type MongoDbLinkedService. 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 'Oracle' for type OracleLinkedService. Set to 'Paypal' for type PaypalLinkedService. Set to 'Phoenix' for type PhoenixLinkedService. Set to 'PostgreSql' for type PostgreSqlLinkedService. Set to 'Presto' for type PrestoLinkedService. Set to 'QuickBooks' for type QuickBooksLinkedService. Set to 'Responsys' for type ResponsysLinkedService. Set to 'Salesforce' for type SalesforceLinkedService. Set to 'SalesforceMarketingCloud' for type SalesforceMarketingCloudLinkedService. 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 'ServiceNow' for type ServiceNowLinkedService. Set to 'Sftp' for type SftpServerLinkedService. Set to 'Shopify' for type ShopifyLinkedService. 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 'Teradata' for type TeradataLinkedService. Set to 'Vertica' for type VerticaLinkedService. Set to 'Web' for type WebLinkedService. Set to 'Xero' for type XeroLinkedService. Set to 'Zoho' for type ZohoLinkedService.	'AmazonMWS' 'AmazonRedshift' 'AmazonS3' 'AzureBatch' 'AzureDatabricks' 'AzureDataLakeAnalytics' 'AzureDataLakeStore' 'AzureKeyVault' 'AzureML' 'AzureMySql' 'AzurePostgreSql' 'AzureSearch' 'AzureSqlDatabase' 'AzureSqlDW' 'AzureStorage' 'Cassandra' 'Concur' 'CosmosDb' 'Couchbase' 'CustomDataSource' 'Db2' 'Drill' 'Dynamics' 'Eloqua' 'FileServer' 'FtpServer' 'GoogleBigQuery' 'Greenplum' 'HBase' 'Hdfs' 'HDInsight' 'HDInsightOnDemand' 'Hive' 'HttpServer' 'Hubspot' 'Impala' 'Jira' 'Magento' 'MariaDB' 'Marketo' 'MongoDb' 'MySql' 'Netezza' 'OData' 'Odbc' 'Oracle' 'Paypal' 'Phoenix' 'PostgreSql' 'Presto' 'QuickBooks' 'Responsys' 'Salesforce' 'SalesforceMarketingCloud' 'SapBW' 'SapCloudForCustomer' 'SapEcc' 'SapHana' 'ServiceNow' 'Sftp' 'Shopify' 'Spark' 'SqlServer' 'Square' 'Sybase' 'Teradata' 'Vertica' 'Web' 'Xero' 'Zoho' (required)

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 (or Expression with resultType string).	any
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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any
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 = 260 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@2017-09-01-preview"

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

MySqlLinkedService

Name	Description	Value
type	Type of linked service.	'MySql' (required)
typeProperties	MySQL linked service properties.	MySqlLinkedServiceTypeProperties (required)

MySqlLinkedServiceTypeProperties

Name	Description	Value
connectionString	The connection string.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	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 (or Expression with resultType string).	any

ODataLinkedService

Name	Description	Value
type	Type of linked service.	'OData' (required)
typeProperties	OData linked service properties.	ODataLinkedServiceTypeProperties (required)

ODataLinkedServiceTypeProperties

Name	Description	Value
authenticationType	Type of authentication used to connect to the OData service.	'Anonymous' 'Basic'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password of the OData service.	SecretBase
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, SecureString or AzureKeyVaultSecretReference.	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 (or Expression with resultType string).	any
password	Password for Basic authentication.	SecretBase
userName	User name for Basic authentication. 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 (or Expression with resultType string).	any

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any

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

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 (required)
accessTokenSecret	The access token secret for OAuth 1.0 authentication.	SecretBase (required)
companyId	The company ID of the QuickBooks company to authorize.	any (required)
consumerKey	The consumer key for OAuth 1.0 authentication.	any (required)
consumerSecret	The consumer secret for OAuth 1.0 authentication.	SecretBase (required)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)	any (required)
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 (or Expression with resultType string).	any
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

SalesforceLinkedService

Name	Description	Value
type	Type of linked service.	'Salesforce' (required)
typeProperties	Salesforce linked service properties.	SalesforceLinkedServiceTypeProperties (required)

SalesforceLinkedServiceTypeProperties

Name	Description	Value
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 required 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 (required)
clientSecret	The client secret associated with the Salesforce Marketing Cloud 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 (or Expression with resultType string).	any
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

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 (or Expression with resultType string).	any
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 (or Expression with resultType string).	any
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 (or Expression with resultType 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).	string (required)
username	The username for Basic authentication. Type: string (or Expression with resultType string).	string

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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 (required)
userName	Username to access the SAP HANA server. Type: string (or Expression with resultType string).	any

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

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' 'SshPublicKey'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
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

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

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

SqlServerLinkedService

Name	Description	Value
type	Type of linked service.	'SqlServer' (required)
typeProperties	SQL Server linked service properties.	SqlServerLinkedServiceTypeProperties (required)

SqlServerLinkedServiceTypeProperties

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 (or Expression with resultType string).	any
password	The on-premises Windows authentication password.	SecretBase
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 (required)
clientSecret	The client secret associated with your Square application.	SecretBase
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
host	The URL of the Square instance. (i.e. mystore.mysquare.com)	any (required)
redirectUri	The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)	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

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

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'
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
password	Password for authentication.	SecretBase
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. 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
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 (or Expression with resultType string).	any
host	The endpoint of the Xero server. (i.e. api.xero.com)	any (required)
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

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
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).	any
endpoint	The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)	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