Microsoft.DataFactory factories/linkedservices

Bicep resource definition

The factories/linkedservices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/linkedservices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/linkedservices@2018-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    annotations: [
      any
    ]
    connectVia: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'IntegrationRuntimeReference'
    }
    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: 'string'
    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 AmazonRdsForOracle, use:

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

For AmazonRdsForSqlServer, use:

  type: 'AmazonRdsForSqlServer'
  typeProperties: {
    alwaysEncryptedSettings: {
      alwaysEncryptedAkvAuthType: 'string'
      credential: {
        referenceName: 'string'
        type: 'CredentialReference'
        {customized property}: any()
      }
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    connectionString: any()
    encryptedCredential: 'string'
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any()
  }

For AmazonRedshift, use:

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

For AmazonS3, use:

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

For AmazonS3Compatible, use:

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

For AppFigures, use:

  type: 'AppFigures'
  typeProperties: {
    clientKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any()
  }

For Asana, use:

  type: 'Asana'
  typeProperties: {
    apiToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
  }

For AzureBatch, use:

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

For AzureBlobFS, use:

  type: 'AzureBlobFS'
  typeProperties: {
    accountKey: any()
    azureCloudType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    sasToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sasUri: any()
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    url: any()
  }

For AzureBlobStorage, use:

  type: 'AzureBlobStorage'
  typeProperties: {
    accountKey: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    accountKind: any()
    authenticationType: 'string'
    azureCloudType: any()
    connectionString: any()
    containerUri: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
    serviceEndpoint: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
  }

For AzureDatabricks, use:

  type: 'AzureDatabricks'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    authentication: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    domain: any()
    encryptedCredential: 'string'
    existingClusterId: any()
    instancePoolId: any()
    newClusterCustomTags: {}
    newClusterDriverNodeType: any()
    newClusterEnableElasticDisk: any()
    newClusterInitScripts: any()
    newClusterLogDestination: any()
    newClusterNodeType: any()
    newClusterNumOfWorker: any()
    newClusterSparkConf: {
      {customized property}: any()
    }
    newClusterSparkEnvVars: {
      {customized property}: any()
    }
    newClusterVersion: any()
    policyId: any()
    workspaceResourceId: any()
  }

For AzureDatabricksDeltaLake, use:

  type: 'AzureDatabricksDeltaLake'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clusterId: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    domain: any()
    encryptedCredential: 'string'
    workspaceResourceId: any()
  }

For AzureDataExplorer, use:

  type: 'AzureDataExplorer'
  typeProperties: {
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    database: any()
    endpoint: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
  }

For AzureDataLakeAnalytics, use:

  type: 'AzureDataLakeAnalytics'
  typeProperties: {
    accountName: any()
    dataLakeAnalyticsUri: any()
    encryptedCredential: 'string'
    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()
    azureCloudType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    dataLakeStoreUri: any()
    encryptedCredential: 'string'
    resourceGroupName: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    subscriptionId: any()
    tenant: any()
  }

For AzureFileStorage, use:

  type: 'AzureFileStorage'
  typeProperties: {
    accountKey: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    connectionString: any()
    encryptedCredential: 'string'
    fileShare: any()
    host: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
    snapshot: any()
    userId: any()
  }

For AzureFunction, use:

  type: 'AzureFunction'
  typeProperties: {
    authentication: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    functionAppUrl: any()
    functionKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    resourceId: any()
  }

For AzureKeyVault, use:

  type: 'AzureKeyVault'
  typeProperties: {
    baseUrl: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
  }

For AzureMariaDB, use:

  type: 'AzureMariaDB'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    pwd: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For AzureML, use:

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

For AzureMLService, use:

  type: 'AzureMLService'
  typeProperties: {
    authentication: any()
    encryptedCredential: 'string'
    mlWorkspaceName: any()
    resourceGroupName: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    subscriptionId: any()
    tenant: any()
  }

For AzureMySql, use:

  type: 'AzureMySql'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For AzurePostgreSql, use:

  type: 'AzurePostgreSql'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For AzureSearch, use:

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

For AzureSqlDatabase, use:

  type: 'AzureSqlDatabase'
  typeProperties: {
    alwaysEncryptedSettings: {
      alwaysEncryptedAkvAuthType: 'string'
      credential: {
        referenceName: 'string'
        type: 'CredentialReference'
        {customized property}: any()
      }
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
  }

For AzureSqlDW, use:

  type: 'AzureSqlDW'
  typeProperties: {
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
  }

For AzureSqlMI, use:

  type: 'AzureSqlMI'
  typeProperties: {
    alwaysEncryptedSettings: {
      alwaysEncryptedAkvAuthType: 'string'
      credential: {
        referenceName: 'string'
        type: 'CredentialReference'
        {customized property}: any()
      }
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
  }

For AzureStorage, use:

  type: 'AzureStorage'
  typeProperties: {
    accountKey: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    connectionString: any()
    encryptedCredential: 'string'
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
  }

For AzureSynapseArtifacts, use:

  type: 'AzureSynapseArtifacts'
  typeProperties: {
    authentication: any()
    endpoint: any()
    workspaceResourceId: any()
  }

For AzureTableStorage, use:

  type: 'AzureTableStorage'
  typeProperties: {
    accountKey: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    connectionString: any()
    encryptedCredential: 'string'
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
  }

For Cassandra, use:

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

For CommonDataServiceForApps, use:

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

For Concur, use:

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

For CosmosDb, use:

  type: 'CosmosDb'
  typeProperties: {
    accountEndpoint: any()
    accountKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    azureCloudType: any()
    connectionMode: 'string'
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    database: any()
    encryptedCredential: 'string'
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: any()
    servicePrincipalId: any()
    tenant: any()
  }

For CosmosDbMongoDbApi, use:

  type: 'CosmosDbMongoDbApi'
  typeProperties: {
    connectionString: any()
    database: any()
    isServerVersionAbove32: any()
  }

For Couchbase, use:

  type: 'Couchbase'
  typeProperties: {
    connectionString: any()
    credString: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    encryptedCredential: 'string'
  }

For CustomDataSource, use:

  type: 'CustomDataSource'
  typeProperties: any()

For Dataworld, use:

  type: 'Dataworld'
  typeProperties: {
    apiToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
  }

For Db2, use:

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

For Drill, use:

  type: 'Drill'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    pwd: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For Dynamics, use:

  type: 'Dynamics'
  typeProperties: {
    authenticationType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    deploymentType: any()
    encryptedCredential: 'string'
    hostName: any()
    organizationName: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any()
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: any()
    servicePrincipalId: any()
    serviceUri: any()
    username: any()
  }

For DynamicsAX, use:

  type: 'DynamicsAX'
  typeProperties: {
    aadResourceId: any()
    encryptedCredential: 'string'
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    url: any()
  }

For DynamicsCrm, use:

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

For Eloqua, use:

  type: 'Eloqua'
  typeProperties: {
    encryptedCredential: 'string'
    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: 'string'
    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: 'string'
    host: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any()
    userName: any()
  }

For GoogleAdWords, use:

  type: 'GoogleAdWords'
  typeProperties: {
    authenticationType: 'string'
    clientCustomerID: any()
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    connectionProperties: any()
    developerToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    email: any()
    encryptedCredential: 'string'
    googleAdsApiVersion: any()
    keyFilePath: any()
    loginCustomerID: any()
    privateKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    supportLegacyDataTypes: any()
    trustedCertPath: any()
    useSystemTrustStore: any()
  }

For GoogleBigQuery, use:

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

For GoogleBigQueryV2, use:

  type: 'GoogleBigQueryV2'
  typeProperties: {
    authenticationType: 'string'
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
    keyFileContent: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    projectId: any()
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleCloudStorage, use:

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

For GoogleSheets, use:

  type: 'GoogleSheets'
  typeProperties: {
    apiToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
  }

For Greenplum, use:

  type: 'Greenplum'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    pwd: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For HBase, use:

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

For Hdfs, use:

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

For HDInsight, use:

  type: 'HDInsight'
  typeProperties: {
    clusterUri: any()
    encryptedCredential: 'string'
    fileSystem: any()
    hcatalogLinkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    isEspEnabled: any()
    linkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    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: 'LinkedServiceReference'
      }
    ]
    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()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    dataNodeSize: any()
    encryptedCredential: 'string'
    hBaseConfiguration: any()
    hcatalogLinkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    hdfsConfiguration: any()
    headNodeSize: any()
    hiveConfiguration: any()
    hostSubscriptionId: any()
    linkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    mapReduceConfiguration: any()
    oozieConfiguration: any()
    scriptActions: [
      {
        name: 'string'
        parameters: 'string'
        roles: any()
        uri: 'string'
      }
    ]
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sparkVersion: any()
    stormConfiguration: any()
    subnetName: any()
    tenant: any()
    timeToLive: any()
    version: any()
    virtualNetworkId: any()
    yarnConfiguration: any()
    zookeeperNodeSize: any()
  }

For Hive, use:

  type: 'Hive'
  typeProperties: {
    allowHostNameCNMismatch: any()
    allowSelfSignedServerCert: any()
    authenticationType: 'string'
    enableSsl: any()
    encryptedCredential: 'string'
    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'
    authHeaders: any()
    certThumbprint: any()
    embeddedCertData: any()
    enableServerCertificateValidation: any()
    encryptedCredential: 'string'
    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: 'string'
    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: 'string'
    host: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any()
    trustedCertPath: any()
    username: any()
    useSystemTrustStore: any()
  }

For Informix, use:

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

For Jira, use:

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

For LakeHouse, use:

  type: 'LakeHouse'
  typeProperties: {
    artifactId: any()
    encryptedCredential: 'string'
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    workspaceId: any()
  }

For Magento, use:

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

For MariaDB, use:

  type: 'MariaDB'
  typeProperties: {
    connectionString: any()
    database: any()
    driverVersion: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    port: any()
    server: any()
    username: any()
  }

For Marketo, use:

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

For MicrosoftAccess, use:

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

For MongoDb, use:

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

For MongoDbAtlas, use:

  type: 'MongoDbAtlas'
  typeProperties: {
    connectionString: any()
    database: any()
    driverVersion: any()
  }

For MongoDbV2, use:

  type: 'MongoDbV2'
  typeProperties: {
    connectionString: any()
    database: any()
  }

For MySql, use:

  type: 'MySql'
  typeProperties: {
    connectionString: any()
    database: any()
    driverVersion: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    port: any()
    server: any()
    sslMode: any()
    username: any()
    useSystemTrustStore: any()
  }

For Netezza, use:

  type: 'Netezza'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    pwd: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For OData, use:

  type: 'OData'
  typeProperties: {
    aadResourceId: any()
    aadServicePrincipalCredentialType: 'string'
    authenticationType: 'string'
    authHeaders: any()
    azureCloudType: any()
    encryptedCredential: 'string'
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalEmbeddedCert: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalEmbeddedCertPassword: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    url: any()
    userName: any()
  }

For Odbc, use:

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

For Office365, use:

  type: 'Office365'
  typeProperties: {
    encryptedCredential: 'string'
    office365TenantId: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalTenantId: any()
  }

For Oracle, use:

  type: 'Oracle'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For OracleCloudStorage, use:

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

For OracleServiceCloud, use:

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

For Paypal, use:

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

For Phoenix, use:

  type: 'Phoenix'
  typeProperties: {
    allowHostNameCNMismatch: any()
    allowSelfSignedServerCert: any()
    authenticationType: 'string'
    enableSsl: any()
    encryptedCredential: 'string'
    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: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For PostgreSqlV2, use:

  type: 'PostgreSqlV2'
  typeProperties: {
    commandTimeout: any()
    connectionTimeout: any()
    database: any()
    encoding: any()
    encryptedCredential: 'string'
    logParameters: any()
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    pooling: any()
    port: any()
    readBufferSize: any()
    schema: any()
    server: any()
    sslCertificate: any()
    sslKey: any()
    sslMode: any()
    sslPassword: any()
    timezone: any()
    trustServerCertificate: any()
    username: any()
  }

For Presto, use:

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

For Quickbase, use:

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

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

For Responsys, use:

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

For RestService, use:

  type: 'RestService'
  typeProperties: {
    aadResourceId: any()
    authenticationType: 'string'
    authHeaders: any()
    azureCloudType: any()
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
      {customized property}: any()
    }
    enableServerCertificateValidation: any()
    encryptedCredential: 'string'
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    resource: any()
    scope: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    tokenEndpoint: any()
    url: any()
    userName: any()
  }

For Salesforce, use:

  type: 'Salesforce'
  typeProperties: {
    apiVersion: any()
    encryptedCredential: 'string'
    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
    }
    connectionProperties: any()
    encryptedCredential: 'string'
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For SalesforceServiceCloud, use:

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

For SalesforceServiceCloudV2, use:

  type: 'SalesforceServiceCloudV2'
  typeProperties: {
    apiVersion: any()
    authenticationType: any()
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
    environmentUrl: any()
  }

For SalesforceV2, use:

  type: 'SalesforceV2'
  typeProperties: {
    apiVersion: any()
    authenticationType: any()
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
    environmentUrl: any()
  }

For SapBW, use:

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

For SapCloudForCustomer, use:

  type: 'SapCloudForCustomer'
  typeProperties: {
    encryptedCredential: 'string'
    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: any()
    username: any()
  }

For SapHana, use:

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

For SapOdp, use:

  type: 'SapOdp'
  typeProperties: {
    clientId: any()
    encryptedCredential: 'string'
    language: any()
    logonGroup: any()
    messageServer: any()
    messageServerService: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any()
    sncLibraryPath: any()
    sncMode: any()
    sncMyName: any()
    sncPartnerName: any()
    sncQop: any()
    subscriberName: any()
    systemId: any()
    systemNumber: any()
    userName: any()
    x509CertificatePath: any()
  }

For SapOpenHub, use:

  type: 'SapOpenHub'
  typeProperties: {
    clientId: any()
    encryptedCredential: 'string'
    language: any()
    logonGroup: any()
    messageServer: any()
    messageServerService: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any()
    systemId: any()
    systemNumber: any()
    userName: any()
  }

For SapTable, use:

  type: 'SapTable'
  typeProperties: {
    clientId: any()
    encryptedCredential: 'string'
    language: any()
    logonGroup: any()
    messageServer: any()
    messageServerService: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    server: any()
    sncLibraryPath: any()
    sncMode: any()
    sncMyName: any()
    sncPartnerName: any()
    sncQop: any()
    systemId: any()
    systemNumber: any()
    userName: any()
  }

For ServiceNow, use:

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

For ServiceNowV2, use:

  type: 'ServiceNowV2'
  typeProperties: {
    authenticationType: 'string'
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
    endpoint: any()
    grantType: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    username: any()
  }

For Sftp, use:

  type: 'Sftp'
  typeProperties: {
    authenticationType: 'string'
    encryptedCredential: 'string'
    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 SharePointOnlineList, use:

  type: 'SharePointOnlineList'
  typeProperties: {
    encryptedCredential: 'string'
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    siteUrl: any()
    tenantId: any()
  }

For Shopify, use:

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

For Smartsheet, use:

  type: 'Smartsheet'
  typeProperties: {
    apiToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential: 'string'
  }

For Snowflake, use:

  type: 'Snowflake'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For SnowflakeV2, use:

  type: 'SnowflakeV2'
  typeProperties: {
    accountIdentifier: any()
    authenticationType: 'string'
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    database: any()
    encryptedCredential: 'string'
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    privateKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    privateKeyPassphrase: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    scope: any()
    tenantId: any()
    user: any()
    warehouse: any()
  }

For Spark, use:

  type: 'Spark'
  typeProperties: {
    allowHostNameCNMismatch: any()
    allowSelfSignedServerCert: any()
    authenticationType: 'string'
    enableSsl: any()
    encryptedCredential: 'string'
    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: {
    alwaysEncryptedSettings: {
      alwaysEncryptedAkvAuthType: 'string'
      credential: {
        referenceName: 'string'
        type: 'CredentialReference'
        {customized property}: any()
      }
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    connectionString: any()
    encryptedCredential: 'string'
    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
    }
    connectionProperties: any()
    encryptedCredential: 'string'
    host: any()
    redirectUri: any()
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For Sybase, use:

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

For TeamDesk, use:

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

For Teradata, use:

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

For Twilio, use:

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

For Vertica, use:

  type: 'Vertica'
  typeProperties: {
    connectionString: any()
    encryptedCredential: 'string'
    pwd: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For Warehouse, use:

  type: 'Warehouse'
  typeProperties: {
    artifactId: any()
    encryptedCredential: 'string'
    endpoint: any()
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    tenant: any()
    workspaceId: any()
  }

For Web, use:

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

For Xero, use:

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

For Zendesk, use:

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

For Zoho, use:

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

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  type: 'AzureKeyVaultSecret'
  secretName: any()
  secretVersion: any()
  store: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }

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

factories/linkedservices

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
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)

LinkedService

Name Description Value
annotations List of tags that can be used for describing the linked service. any[]
connectVia The integration runtime reference. IntegrationRuntimeReference
description Linked service description. string
parameters Parameters for linked service. ParameterDefinitionSpecification
type Set the object type AmazonMWS
AmazonRdsForOracle
AmazonRdsForSqlServer
AmazonRedshift
AmazonS3
AmazonS3Compatible
AppFigures
Asana
AzureBatch
AzureBlobFS
AzureBlobStorage
AzureDatabricks
AzureDatabricksDeltaLake
AzureDataExplorer
AzureDataLakeAnalytics
AzureDataLakeStore
AzureFileStorage
AzureFunction
AzureKeyVault
AzureMariaDB
AzureML
AzureMLService
AzureMySql
AzurePostgreSql
AzureSearch
AzureSqlDatabase
AzureSqlDW
AzureSqlMI
AzureStorage
AzureSynapseArtifacts
AzureTableStorage
Cassandra
CommonDataServiceForApps
Concur
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomDataSource
Dataworld
Db2
Drill
Dynamics
DynamicsAX
DynamicsCrm
Eloqua
FileServer
FtpServer
GoogleAdWords
GoogleBigQuery
GoogleBigQueryV2
GoogleCloudStorage
GoogleSheets
Greenplum
HBase
Hdfs
HDInsight
HDInsightOnDemand
Hive
HttpServer
Hubspot
Impala
Informix
Jira
LakeHouse
Magento
MariaDB
Marketo
MicrosoftAccess
MongoDb
MongoDbAtlas
MongoDbV2
MySql
Netezza
OData
Odbc
Office365
Oracle
OracleCloudStorage
OracleServiceCloud
Paypal
Phoenix
PostgreSql
PostgreSqlV2
Presto
Quickbase
QuickBooks
Responsys
RestService
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SalesforceServiceCloudV2
SalesforceV2
SapBW
SapCloudForCustomer
SapEcc
SapHana
SapOdp
SapOpenHub
SapTable
ServiceNow
ServiceNowV2
Sftp
SharePointOnlineList
Shopify
Smartsheet
Snowflake
SnowflakeV2
Spark
SqlServer
Square
Sybase
TeamDesk
Teradata
Twilio
Vertica
Warehouse
Web
Xero
Zendesk
Zoho (required)

IntegrationRuntimeReference

Name Description Value
parameters Arguments for integration runtime. ParameterValueSpecification
referenceName Reference integration runtime name. string (required)
type Type of integration runtime. 'IntegrationRuntimeReference' (required)

ParameterValueSpecification

Name Description Value
{customized property} For Bicep, you can use the any() function.

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter. For Bicep, you can use the any() function.
type Parameter type. 'Array'
'Bool'
'Float'
'Int'
'Object'
'SecureString'
'String' (required)

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. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) For Bicep, you can use the any() function.(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) For Bicep, you can use the any() function.(required)
mwsAuthToken The Amazon MWS authentication token. SecretBase
secretKey The secret key used to access data. SecretBase
sellerID The Amazon seller ID. For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

SecretBase

Name Description Value
type Set the object type AzureKeyVaultSecret
SecureString (required)

AzureKeyVaultSecretReference

Name Description Value
secretName The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.
store The Azure Key Vault linked service reference. LinkedServiceReference (required)
type Type of the secret. string (required)

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference' (required)

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

AmazonRdsForOracleLinkedService

Name Description Value
type Type of linked service. 'AmazonRdsForOracle' (required)
typeProperties AmazonRdsForOracle database linked service properties. AmazonRdsForLinkedServiceTypeProperties (required)

AmazonRdsForLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase

AmazonRdsForSqlServerLinkedService

Name Description Value
type Type of linked service. 'AmazonRdsForSqlServer' (required)
typeProperties Amazon RDS for SQL Server linked service properties. AmazonRdsForSqlServerLinkedServiceTypeProperties (required)

AmazonRdsForSqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SqlAlwaysEncryptedProperties

Name Description Value
alwaysEncryptedAkvAuthType Sql always encrypted AKV authentication type. Type: string. 'ManagedIdentity'
'ServicePrincipal'
'UserAssignedManagedIdentity' (required)
credential The credential reference containing authentication information. CredentialReference
servicePrincipalId The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The key of the service principal used to authenticate against Azure Key Vault. SecretBase

CredentialReference

Name Description Value
referenceName Reference credential name. string (required)
type Credential reference type. 'CredentialReference' (required)
{customized property} For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Amazon Redshift source. SecretBase
port The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer). For Bicep, you can use the any() function.
server The name of the Amazon Redshift server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
username The username of the Amazon Redshift source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
authenticationType The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Amazon S3 Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sessionToken The session token for the S3 temporary security credential. SecretBase

AmazonS3CompatibleLinkedService

Name Description Value
type Type of linked service. 'AmazonS3Compatible' (required)
typeProperties Amazon S3 Compatible linked service properties. AmazonS3CompatibleLinkedServiceTypeProperties (required)

AmazonS3CompatibleLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
forcePathStyle If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
secretAccessKey The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AppFiguresLinkedService

Name Description Value
type Type of linked service. 'AppFigures' (required)
typeProperties AppFigures linked service properties. AppFiguresLinkedServiceTypeProperties (required)

AppFiguresLinkedServiceTypeProperties

Name Description Value
clientKey The client key for the AppFigures source. SecretBase (required)
password The password of the AppFigures source. SecretBase (required)
userName The username of the Appfigures source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

AsanaLinkedService

Name Description Value
type Type of linked service. 'Asana' (required)
typeProperties Asana linked service properties. AsanaLinkedServiceTypeProperties (required)

AsanaLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Asana source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

AzureBatchLinkedService

Name Description Value
type Type of linked service. 'AzureBatch' (required)
typeProperties Azure Batch linked service properties. AzureBatchLinkedServiceTypeProperties (required)

AzureBatchLinkedServiceTypeProperties

Name Description Value
accessKey The Azure Batch account access key. SecretBase
accountName The Azure Batch account name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
batchUri The Azure Batch URI. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
linkedServiceName The Azure Storage linked service reference. LinkedServiceReference (required)
poolName The Azure Batch pool name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

AzureBlobFSLinkedService

Name Description Value
type Type of linked service. 'AzureBlobFS' (required)
typeProperties Azure Data Lake Storage Gen2 linked service properties. AzureBlobFSLinkedServiceTypeProperties (required)

AzureBlobFSLinkedServiceTypeProperties

Name Description Value
accountKey Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. SecretBase
sasUri SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
url Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureBlobStorageLinkedService

Name Description Value
type Type of linked service. 'AzureBlobStorage' (required)
typeProperties Azure Blob Storage linked service properties. AzureBlobStorageLinkedServiceTypeProperties (required)

AzureBlobStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
accountKind Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
authenticationType The type used for authentication. Type: string. 'AccountKey'
'Anonymous'
'Msi'
'SasUri'
'ServicePrincipal'
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
containerUri Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
serviceEndpoint Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. For Bicep, you can use the any() function.
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

AzureDatabricksLinkedService

Name Description Value
type Type of linked service. 'AzureDatabricks' (required)
typeProperties Azure Databricks linked service properties. AzureDatabricksLinkedServiceTypeProperties (required)

AzureDatabricksLinkedServiceTypeProperties

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

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property} For Bicep, you can use the any() function.

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property} For Bicep, you can use the any() function.

AzureDatabricksDeltaLakeLinkedService

Name Description Value
type Type of linked service. 'AzureDatabricksDeltaLake' (required)
typeProperties Azure Databricks Delta Lake linked service properties. AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required)

AzureDatabricksDetltaLakeLinkedServiceTypeProperties

Name Description Value
accessToken Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. SecretBase
clusterId The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
domain {REGION}.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
workspaceResourceId Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureDataExplorerLinkedService

Name Description Value
type Type of linked service. 'AzureDataExplorer' (required)
typeProperties Azure Data Explorer (Kusto) linked service properties. AzureDataExplorerLinkedServiceTypeProperties (required)

AzureDataExplorerLinkedServiceTypeProperties

Name Description Value
credential The credential reference containing authentication information. CredentialReference
database Database name for connection. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
endpoint The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://{clusterName}.{regionName}.kusto.windows.net. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.(required)
servicePrincipalId The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The key of the service principal used to authenticate against Kusto. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
dataLakeAnalyticsUri Azure Data Lake Analytics URI Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
dataLakeStoreUri Data Lake Store service URI. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureFileStorageLinkedService

Name Description Value
type Type of linked service. 'AzureFileStorage' (required)
typeProperties Azure File Storage linked service properties. AzureFileStorageLinkedServiceTypeProperties (required)

AzureFileStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileShare The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
host Host name of the server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to logon the server. SecretBase
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
snapshot The azure file share snapshot version. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
userId User ID to logon the server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureFunctionLinkedService

Name Description Value
type Type of linked service. 'AzureFunction' (required)
typeProperties Azure Function linked service properties. AzureFunctionLinkedServiceTypeProperties (required)

AzureFunctionLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
functionAppUrl The endpoint of the Azure Function App. URL will be in the format https://{accountName}.azurewebsites.net. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
functionKey Function or Host key for Azure Function App. SecretBase
resourceId Allowed token audiences for azure function. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference

AzureMariaDBLinkedService

Name Description Value
type Type of linked service. 'AzureMariaDB' (required)
typeProperties Azure Database for MariaDB linked service properties. AzureMariaDBLinkedServiceTypeProperties (required)

AzureMariaDBLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureMLLinkedService

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

AzureMLLinkedServiceTypeProperties

Name Description Value
apiKey The API key for accessing the Azure ML model endpoint. SecretBase (required)
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlEndpoint The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalId The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
updateResourceEndpoint The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureMLServiceLinkedService

Name Description Value
type Type of linked service. 'AzureMLService' (required)
typeProperties Azure ML Service linked service properties. AzureMLServiceLinkedServiceTypeProperties (required)

AzureMLServiceLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlWorkspaceName Azure ML Service workspace name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
resourceGroupName Azure ML Service workspace resource group name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalId The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. SecretBase
subscriptionId Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzurePostgreSqlLinkedService

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

AzurePostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureSearchLinkedService

Name Description Value
type Type of linked service. 'AzureSearch' (required)
typeProperties Windows Azure Search Service linked service properties. AzureSearchLinkedServiceTypeProperties (required)

AzureSearchLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
key Admin Key for Azure Search service SecretBase
url URL for Azure Search service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

AzureSqlDatabaseLinkedService

Name Description Value
type Type of linked service. 'AzureSqlDatabase' (required)
typeProperties Azure SQL Database linked service properties. AzureSqlDatabaseLinkedServiceTypeProperties (required)

AzureSqlDatabaseLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

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
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

AzureSqlMILinkedService

Name Description Value
type Type of linked service. 'AzureSqlMI' (required)
typeProperties Azure SQL Managed Instance linked service properties. AzureSqlMILinkedServiceTypeProperties (required)

AzureSqlMILinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The key of the service principal used to authenticate against Azure SQL Managed Instance. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureStorageLinkedService

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

AzureStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.

AzureSynapseArtifactsLinkedService

Name Description Value
type Type of linked service. 'AzureSynapseArtifacts' (required)
typeProperties Azure Synapse Analytics (Artifacts) linked service properties. AzureSynapseArtifactsLinkedServiceTypeProperties (required)

AzureSynapseArtifactsLinkedServiceTypeProperties

Name Description Value
authentication Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
endpoint https://{workspacename}.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
workspaceResourceId The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureTableStorageLinkedService

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

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). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name for connection. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
password Password for authentication. SecretBase
port The port for the connection. Type: integer (or Expression with resultType integer). For Bicep, you can use the any() function.
username Username for authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

CommonDataServiceForAppsLinkedService

Name Description Value
type Type of linked service. 'CommonDataServiceForApps' (required)
typeProperties Common Data Service for Apps linked service properties. CommonDataServiceForAppsLinkedServiceTypeProperties (required)

CommonDataServiceForAppsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
deploymentType The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
organizationName The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to access the Common Data Service for Apps instance. SecretBase
port The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. For Bicep, you can use the any() function.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
serviceUri The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
username User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.(required)
connectionProperties Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password corresponding to the user name that you provided in the username field. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.
username The user name that you use to access Concur Service. For Bicep, you can use the any() function.(required)

CosmosDbLinkedService

Name Description Value
type Type of linked service. 'CosmosDb' (required)
typeProperties CosmosDB linked service properties. CosmosDbLinkedServiceTypeProperties (required)

CosmosDbLinkedServiceTypeProperties

Name Description Value
accountEndpoint The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
accountKey The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. SecretBase
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionMode The connection mode used to access CosmosDB account. Type: string. 'Direct'
'Gateway'
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
database The name of the database. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. For Bicep, you can use the any() function.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

CosmosDbMongoDbApiLinkedService

Name Description Value
type Type of linked service. 'CosmosDbMongoDbApi' (required)
typeProperties CosmosDB (MongoDB API) linked service properties. CosmosDbMongoDbApiLinkedServiceTypeProperties (required)

CosmosDbMongoDbApiLinkedServiceTypeProperties

Name Description Value
connectionString The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
database The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
isServerVersionAbove32 Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
credString The Azure key vault secret reference of credString in connection string. AzureKeyVaultSecretReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

CustomDataSourceLinkedService

Name Description Value
type Type of linked service. 'CustomDataSource' (required)
typeProperties Custom linked service properties. For Bicep, you can use the any() function.(required)

DataworldLinkedService

Name Description Value
type Type of linked service. 'Dataworld' (required)
typeProperties Dataworld linked service properties. DataworldLinkedServiceTypeProperties (required)

DataworldLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Dataworld source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

Db2LinkedService

Name Description Value
type Type of linked service. 'Db2' (required)
typeProperties DB2 linked service properties. Db2LinkedServiceTypeProperties (required)

Db2LinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. 'Basic'
certificateCommonName Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
database Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. string
packageCollection Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password for authentication. SecretBase
server Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
username Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

DynamicsLinkedService

Name Description Value
type Type of linked service. 'Dynamics' (required)
typeProperties Dynamics linked service properties. DynamicsLinkedServiceTypeProperties (required)

DynamicsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
credential The credential reference containing authentication information. CredentialReference
deploymentType The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
username User name to access the Dynamics instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

DynamicsAXLinkedService

Name Description Value
type Type of linked service. 'DynamicsAX' (required)
typeProperties Dynamics AX linked service properties. DynamicsAXLinkedServiceTypeProperties (required)

DynamicsAXLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalKey Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string). SecretBase (required)
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
url The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint. For Bicep, you can use the any() function.(required)

DynamicsCrmLinkedService

Name Description Value
type Type of linked service. 'DynamicsCrm' (required)
typeProperties Dynamics CRM linked service properties. DynamicsCrmLinkedServiceTypeProperties (required)

DynamicsCrmLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
deploymentType The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
organizationName The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to access the Dynamics CRM instance. SecretBase
port The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. For Bicep, you can use the any() function.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
serviceUri The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
username User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

EloquaLinkedService

Name Description Value
type Type of linked service. 'Eloqua' (required)
typeProperties Eloqua server linked service properties. EloquaLinkedServiceTypeProperties (required)

EloquaLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Eloqua server. (i.e. eloqua.example.com) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.
username The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice) For Bicep, you can use the any() function.(required)

FileServerLinkedService

Name Description Value
type Type of linked service. 'FileServer' (required)
typeProperties File system linked service properties. FileServerLinkedServiceTypeProperties (required)

FileServerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
password Password to logon the server. SecretBase
userId User ID to logon the server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
enableSsl If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the FTP server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
userName Username to logon the FTP server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

GoogleAdWordsLinkedService

Name Description Value
type Type of linked service. 'GoogleAdWords' (required)
typeProperties Google AdWords service linked service properties. GoogleAdWordsLinkedServiceTypeProperties (required)

GoogleAdWordsLinkedServiceTypeProperties

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

GoogleBigQueryLinkedService

Name Description Value
type Type of linked service. 'GoogleBigQuery' (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryLinkedServiceTypeProperties (required)

GoogleBigQueryLinkedServiceTypeProperties

Name Description Value
additionalProjects A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
authenticationType The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. 'ServiceAuthentication'
'UserAuthentication' (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFilePath The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
project The default BigQuery project to query against. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase
requestGoogleDriveScope Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
trustedCertPath The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.

GoogleBigQueryV2LinkedService

Name Description Value
type Type of linked service. 'GoogleBigQueryV2' (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryV2LinkedServiceTypeProperties (required)

GoogleBigQueryV2LinkedServiceTypeProperties

Name Description Value
authenticationType The OAuth 2.0 authentication mechanism used for authentication. 'ServiceAuthentication'
'UserAuthentication' (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clientSecret The client secret of the google application used to acquire the refresh token. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFileContent The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). SecretBase
projectId The default BigQuery project id to query against. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase

GoogleCloudStorageLinkedService

Name Description Value
type Type of linked service. 'GoogleCloudStorage' (required)
typeProperties Google Cloud Storage linked service properties. GoogleCloudStorageLinkedServiceTypeProperties (required)

GoogleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

GoogleSheetsLinkedService

Name Description Value
type Type of linked service. 'GoogleSheets' (required)
typeProperties GoogleSheets linked service properties. GoogleSheetsLinkedServiceTypeProperties (required)

GoogleSheetsLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the GoogleSheets source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

GreenplumLinkedService

Name Description Value
type Type of linked service. 'Greenplum' (required)
typeProperties Greenplum Database linked service properties. GreenplumLinkedServiceTypeProperties (required)

GreenplumLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

HBaseLinkedService

Name Description Value
type Type of linked service. 'HBase' (required)
typeProperties HBase server linked service properties. HBaseLinkedServiceTypeProperties (required)

HBaseLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the HBase server. (i.e. 192.168.222.160) For Bicep, you can use the any() function.(required)
httpPath The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
username The user name used to connect to the HBase instance. For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Windows authentication. SecretBase
url The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName User name for Windows authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileSystem Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
hcatalogLinkedServiceName A reference to the Azure SQL linked service that points to the HCatalog database. LinkedServiceReference
isEspEnabled Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean. For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
clusterPassword The password to access the cluster. SecretBase
clusterResourceGroup The resource group where the cluster belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
clusterSize Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.
clusterType The cluster type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clusterUserName The username to access the cluster. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
coreConfiguration Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. For Bicep, you can use the any() function.
credential The credential reference containing authentication information. CredentialReference
dataNodeSize Specifies the size of the data node for the HDInsight cluster. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hBaseConfiguration Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
headNodeSize Specifies the size of the head node for the HDInsight cluster. For Bicep, you can use the any() function.
hiveConfiguration Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. For Bicep, you can use the any() function.
hostSubscriptionId The customer’s subscription to host the cluster. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
oozieConfiguration Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. For Bicep, you can use the any() function.
scriptActions Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. ScriptAction[]
servicePrincipalId The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
stormConfiguration Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. For Bicep, you can use the any() function.
subnetName The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tenant The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.(required)
version Version of the HDInsight cluster.  Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
virtualNetworkId The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
yarnConfiguration Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. For Bicep, you can use the any() function.
zookeeperNodeSize Specifies the size of the Zoo Keeper node for the HDInsight cluster. For Bicep, you can use the any() function.

ScriptAction

Name Description Value
name The user provided name of the script action. string (required)
parameters The parameters for the script action. string
roles The node types on which the script action should be executed. For Bicep, you can use the any() function.(required)
uri The URI for the script action. string (required)

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. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). For Bicep, you can use the any() function.(required)
httpPath The partial URL corresponding to the Hive server. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
serverType The type of Hive server. 'HiveServer1'
'HiveServer2'
'HiveThriftServer'
serviceDiscoveryMode true to indicate using the ZooKeeper service, false not. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
useNativeQuery Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL. For Bicep, you can use the any() function.
username The user name that you use to access Hive Server. For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. For Bicep, you can use the any() function.
zooKeeperNameSpace The namespace on ZooKeeper under which Hive Server 2 nodes are added. For Bicep, you can use the any() function.

HttpLinkedService

Name Description Value
type Type of linked service. 'HttpServer' (required)
typeProperties Properties specific to this linked service type. HttpLinkedServiceTypeProperties (required)

HttpLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the HTTP server. 'Anonymous'
'Basic'
'ClientCertificate'
'Digest'
'Windows'
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
enableServerCertificateValidation If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. SecretBase
url The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.(required)
clientSecret The client secret associated with your Hubspot application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
refreshToken The refresh token obtained when initially authenticating your OAuth integration. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Impala server. (i.e. 192.168.222.160) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
username The user name used to access the Impala server. The default value is anonymous when using SASLUsername. For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. For Bicep, you can use the any() function.

InformixLinkedService

Name Description Value
type Type of linked service. 'Informix' (required)
typeProperties Informix linked service properties. InformixLinkedServiceTypeProperties (required)

InformixLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. For Bicep, you can use the any() function.(required)
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

JiraLinkedService

Name Description Value
type Type of linked service. 'Jira' (required)
typeProperties Jira Service linked service properties. JiraLinkedServiceTypeProperties (required)

JiraLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Jira service. (e.g. jira.example.com) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.
username The user name that you use to access Jira Service. For Bicep, you can use the any() function.(required)

LakeHouseLinkedService

Name Description Value
type Type of linked service. 'LakeHouse' (required)
typeProperties Microsoft Fabric LakeHouse linked service properties. LakeHouseLinkedServiceTypeProperties (required)

LakeHouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric LakeHouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

MagentoLinkedService

Name Description Value
type Type of linked service. 'Magento' (required)
typeProperties Magento server linked service properties. MagentoLinkedServiceTypeProperties (required)

MagentoLinkedServiceTypeProperties

Name Description Value
accessToken The access token from Magento. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Magento instance. (i.e. 192.168.222.110/magento3) For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
database Database name for connection. Type: string. For Bicep, you can use the any() function.
driverVersion The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer. For Bicep, you can use the any() function.
server Server name for connection. Type: string. For Bicep, you can use the any() function.
username Username for authentication. Type: string. For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.(required)
clientSecret The client secret of your Marketo service. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

MicrosoftAccessLinkedService

Name Description Value
type Type of linked service. 'MicrosoftAccess' (required)
typeProperties Microsoft Access linked service properties. MicrosoftAccessLinkedServiceTypeProperties (required)

MicrosoftAccessLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. For Bicep, you can use the any() function.(required)
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
databaseName The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
port The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0. For Bicep, you can use the any() function.
server The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
username Username for authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

MongoDbAtlasLinkedService

Name Description Value
type Type of linked service. 'MongoDbAtlas' (required)
typeProperties MongoDB Atlas linked service properties. MongoDbAtlasLinkedServiceTypeProperties (required)

MongoDbAtlasLinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
database The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
driverVersion The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

MongoDbV2LinkedService

Name Description Value
type Type of linked service. 'MongoDbV2' (required)
typeProperties MongoDB linked service properties. MongoDbV2LinkedServiceTypeProperties (required)

MongoDbV2LinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
database The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

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. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
database Database name for connection. Type: string. For Bicep, you can use the any() function.
driverVersion The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer. For Bicep, you can use the any() function.
server Server name for connection. Type: string. For Bicep, you can use the any() function.
sslMode SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full. For Bicep, you can use the any() function.
username Username for authentication. Type: string. For Bicep, you can use the any() function.
useSystemTrustStore Use system trust store for connection. Type: integer. 0: enable, 1: disable. For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

ODataLinkedService

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

ODataLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
aadServicePrincipalCredentialType Specify the credential type (key or cert) is used for service principal. 'ServicePrincipalCert'
'ServicePrincipalKey'
authenticationType Type of authentication used to connect to the OData service. 'AadServicePrincipal'
'Anonymous'
'Basic'
'ManagedServiceIdentity'
'Windows'
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). For Bicep, you can use the any() function.
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password of the OData service. SecretBase
servicePrincipalEmbeddedCert Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
servicePrincipalEmbeddedCertPassword Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). SecretBase
servicePrincipalId Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
url The URL of the OData service endpoint. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName User name of the OData service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. For Bicep, you can use the any() function.(required)
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

Office365LinkedService

Name Description Value
type Type of linked service. 'Office365' (required)
typeProperties Office365 linked service properties. Office365LinkedServiceTypeProperties (required)

Office365LinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
office365TenantId Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalKey Specify the application's key. SecretBase (required)
servicePrincipalTenantId Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

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. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

OracleCloudStorageLinkedService

Name Description Value
type Type of linked service. 'OracleCloudStorage' (required)
typeProperties Oracle Cloud Storage linked service properties. OracleCloudStorageLinkedServiceTypeProperties (required)

OracleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

OracleServiceCloudLinkedService

Name Description Value
type Type of linked service. 'OracleServiceCloud' (required)
typeProperties Oracle Service Cloud linked service properties. OracleServiceCloudLinkedServiceTypeProperties (required)

OracleServiceCloudLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Oracle Service Cloud instance. For Bicep, you can use the any() function.(required)
password The password corresponding to the user name that you provided in the username key. SecretBase (required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
username The user name that you use to access Oracle Service Cloud server. For Bicep, you can use the any() function.(required)

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. For Bicep, you can use the any() function.(required)
clientSecret The client secret associated with your PayPal application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) For Bicep, you can use the any() function.(required)
httpPath The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
username The user name used to connect to the Phoenix server. For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. For Bicep, you can use the any() function.

PostgreSqlLinkedService

Name Description Value
type Type of linked service. 'PostgreSql' (required)
typeProperties PostgreSQL linked service properties. PostgreSqlLinkedServiceTypeProperties (required)

PostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

PostgreSqlV2LinkedService

Name Description Value
type Type of linked service. 'PostgreSqlV2' (required)
typeProperties PostgreSQLV2 linked service properties. PostgreSqlV2LinkedServiceTypeProperties (required)

PostgreSqlV2LinkedServiceTypeProperties

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

PrestoLinkedService

Name Description Value
type Type of linked service. 'Presto' (required)
typeProperties Presto server linked service properties. PrestoLinkedServiceTypeProperties (required)

PrestoLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
authenticationType The authentication mechanism used to connect to the Presto server. 'Anonymous'
'LDAP' (required)
catalog The catalog context for all request against the server. For Bicep, you can use the any() function.(required)
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Presto server. (i.e. 192.168.222.160) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
serverVersion The version of the Presto server. (i.e. 0.148-t) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
username The user name used to connect to the Presto server. For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. For Bicep, you can use the any() function.

QuickbaseLinkedService

Name Description Value
type Type of linked service. 'Quickbase' (required)
typeProperties Quickbase linked service properties. QuickbaseLinkedServiceTypeProperties (required)

QuickbaseLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
url The url to connect Quickbase source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userToken The user token for the Quickbase source. SecretBase (required)

QuickBooksLinkedService

Name Description Value
type Type of linked service. 'QuickBooks' (required)
typeProperties QuickBooks server linked service properties. QuickBooksLinkedServiceTypeProperties (required)

QuickBooksLinkedServiceTypeProperties

Name Description Value
accessToken The access token for OAuth 1.0 authentication. SecretBase
accessTokenSecret The access token secret for OAuth 1.0 authentication. SecretBase
companyId The company ID of the QuickBooks company to authorize. For Bicep, you can use the any() function.
connectionProperties Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
consumerKey The consumer key for OAuth 1.0 authentication. For Bicep, you can use the any() function.
consumerSecret The consumer secret for OAuth 1.0 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) For Bicep, you can use the any() function.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
clientSecret The client secret associated with the Responsys application. Type: string (or Expression with resultType string). SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Responsys server. For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

RestServiceLinkedService

Name Description Value
type Type of linked service. 'RestService' (required)
typeProperties Rest Service linked service properties. RestServiceLinkedServiceTypeProperties (required)

RestServiceLinkedServiceTypeProperties

Name Description Value
aadResourceId The resource you are requesting authorization to use. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
authenticationType Type of authentication used to connect to the REST service. 'AadServicePrincipal'
'Anonymous'
'Basic'
'ManagedServiceIdentity'
'OAuth2ClientCredential' (required)
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object). For Bicep, you can use the any() function.
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clientId The client ID associated with your application. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clientSecret The client secret associated with your application. SecretBase
credential The credential reference containing authentication information. CredentialReference
enableServerCertificateValidation Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password used in Basic authentication type. SecretBase
resource The target service or resource to which the access will be requested. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
scope The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The application's key used in AadServicePrincipal authentication type. SecretBase
tenant The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tokenEndpoint The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
url The base URL of the REST service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName The user name used in Basic authentication type. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceLinkedService

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

SalesforceLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.
clientSecret The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). SecretBase
connectionProperties Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.

SalesforceServiceCloudLinkedService

Name Description Value
type Type of linked service. 'SalesforceServiceCloud' (required)
typeProperties Salesforce Service Cloud linked service properties. SalesforceServiceCloudLinkedServiceTypeProperties (required)

SalesforceServiceCloudLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
extendedProperties Extended properties appended to the connection string. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceServiceCloudV2LinkedService

Name Description Value
type Type of linked service. 'SalesforceServiceCloudV2' (required)
typeProperties Salesforce Service Cloud V2 linked service properties. SalesforceServiceCloudV2LinkedServiceTypeProperties (required)

SalesforceServiceCloudV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value For Bicep, you can use the any() function.
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceV2LinkedService

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

SalesforceV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value For Bicep, you can use the any() function.
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP BW server. SecretBase
server Host name of the SAP BW instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.(required)
userName Username to access the SAP BW server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapCloudForCustomerLinkedService

Name Description Value
type Type of linked service. 'SapCloudForCustomer' (required)
typeProperties SAP Cloud for Customer linked service properties. SapCloudForCustomerLinkedServiceTypeProperties (required)

SapCloudForCustomerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
username The username for Basic authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapEccLinkedService

Name Description Value
type Type of linked service. 'SapEcc' (required)
typeProperties SAP ECC linked service properties. SapEccLinkedServiceTypeProperties (required)

SapEccLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
username The username for Basic authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapHanaLinkedService

Name Description Value
type Type of linked service. 'SapHana' (required)
typeProperties Properties specific to this linked service type. SapHanaLinkedServiceProperties (required)

SapHanaLinkedServiceProperties

Name Description Value
authenticationType The authentication type to be used to connect to the SAP HANA server. 'Basic'
'Windows'
connectionString SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP HANA server. SecretBase
server Host name of the SAP HANA server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
userName Username to access the SAP HANA server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapOdpLinkedService

Name Description Value
type Type of linked service. 'SapOdp' (required)
typeProperties Properties specific to SAP ODP linked service type. SapOdpLinkedServiceTypeProperties (required)

SapOdpLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
subscriberName The subscriber name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
x509CertificatePath SNC X509 certificate file path. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapOpenHubLinkedService

Name Description Value
type Type of linked service. 'SapOpenHub' (required)
typeProperties Properties specific to SAP Business Warehouse Open Hub Destination linked service type. SapOpenHubLinkedServiceTypeProperties (required)

SapOpenHubLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to access the SAP BW server where the open hub destination is located. SecretBase
server Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemNumber System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
userName Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapTableLinkedService

Name Description Value
type Type of linked service. 'SapTable' (required)
typeProperties Properties specific to this linked service type. SapTableLinkedServiceTypeProperties (required)

SapTableLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNow server. (i.e. {instance}.service-now.com) For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.
username The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. For Bicep, you can use the any() function.

ServiceNowV2LinkedService

Name Description Value
type Type of linked service. 'ServiceNowV2' (required)
typeProperties ServiceNowV2 server linked service properties. ServiceNowV2LinkedServiceTypeProperties (required)

ServiceNowV2LinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to use. 'Basic'
'OAuth2' (required)
clientId The client id for OAuth2 authentication. For Bicep, you can use the any() function.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNowV2 server. (i.e. {instance}.service-now.com) For Bicep, you can use the any() function.(required)
grantType GrantType for OAuth2 authentication. Default value is password. For Bicep, you can use the any() function.
password The password corresponding to the user name for Basic and OAuth2 authentication. SecretBase
username The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication. For Bicep, you can use the any() function.

SftpServerLinkedService

Name Description Value
type Type of linked service. 'Sftp' (required)
typeProperties Properties specific to this linked service type. SftpServerLinkedServiceTypeProperties (required)

SftpServerLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the FTP server. 'Basic'
'MultiFactor'
'SshPublicKey'
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The SFTP server host name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(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). For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
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). For Bicep, you can use the any() function.
skipHostKeyValidation If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
userName The username used to log on to the SFTP server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SharePointOnlineListLinkedService

Name Description Value
type Type of linked service. 'SharePointOnlineList' (required)
typeProperties SharePoint Online List linked service properties. SharePointOnlineListLinkedServiceTypeProperties (required)

SharePointOnlineListLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalKey The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase (required)
siteUrl The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
tenantId The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

ShopifyLinkedService

Name Description Value
type Type of linked service. 'Shopify' (required)
typeProperties Shopify Service linked service properties. ShopifyLinkedServiceTypeProperties (required)

ShopifyLinkedServiceTypeProperties

Name Description Value
accessToken The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Shopify server. (i.e. mystore.myshopify.com) For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

SmartsheetLinkedService

Name Description Value
type Type of linked service. 'Smartsheet' (required)
typeProperties Smartsheet linked service properties. SmartsheetLinkedServiceTypeProperties (required)

SmartsheetLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Smartsheet source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

SnowflakeLinkedService

Name Description Value
type Type of linked service. 'Snowflake' (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedServiceTypeProperties (required)

SnowflakeLinkedServiceTypeProperties

Name Description Value
connectionString The connection string of snowflake. Type: string, SecureString. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

SnowflakeV2LinkedService

Name Description Value
type Type of linked service. 'SnowflakeV2' (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedV2ServiceTypeProperties (required)

SnowflakeLinkedV2ServiceTypeProperties

Name Description Value
accountIdentifier The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure For Bicep, you can use the any() function.(required)
authenticationType The type used for authentication. Type: string. 'AADServicePrincipal'
'Basic'
'KeyPair'
clientId The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. For Bicep, you can use the any() function.
clientSecret The Azure key vault secret reference of client secret for AADServicePrincipal authentication. SecretBase
database The name of the Snowflake database. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase
privateKey The Azure key vault secret reference of privateKey for KeyPair auth. SecretBase
privateKeyPassphrase The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. SecretBase
scope The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication. For Bicep, you can use the any() function.
tenantId The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. For Bicep, you can use the any() function.
user The name of the Snowflake user. For Bicep, you can use the any() function.
warehouse The name of the Snowflake warehouse. For Bicep, you can use the any() function.(required)

SparkLinkedService

Name Description Value
type Type of linked service. 'Spark' (required)
typeProperties Spark Server linked service properties. SparkLinkedServiceTypeProperties (required)

SparkLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. For Bicep, you can use the any() function.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Spark server For Bicep, you can use the any() function.(required)
httpPath The partial URL corresponding to the Spark server. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.(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. For Bicep, you can use the any() function.
username The user name that you use to access Spark Server. For Bicep, you can use the any() function.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. For Bicep, you can use the any() function.

SqlServerLinkedService

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

SqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

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. For Bicep, you can use the any() function.
clientSecret The client secret associated with your Square application. SecretBase
connectionProperties Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Square instance. (i.e. mystore.mysquare.com) For Bicep, you can use the any() function.
redirectUri The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) For Bicep, you can use the any() function.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

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). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
schema Schema name for connection. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
server Server name for connection. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
username Username for authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

TeamDeskLinkedService

Name Description Value
type Type of linked service. 'TeamDesk' (required)
typeProperties TeamDesk linked service properties. TeamDeskLinkedServiceTypeProperties (required)

TeamDeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the TeamDesk source. SecretBase
authenticationType The authentication type to use. 'Basic'
'Token' (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the TeamDesk source. SecretBase
url The url to connect TeamDesk source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName The username of the TeamDesk source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

TeradataLinkedService

Name Description Value
type Type of linked service. 'Teradata' (required)
typeProperties Teradata linked service properties. TeradataLinkedServiceTypeProperties (required)

TeradataLinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. 'Basic'
'Windows'
connectionString Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
server Server name for connection. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
username Username for authentication. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

TwilioLinkedService

Name Description Value
type Type of linked service. 'Twilio' (required)
typeProperties Twilio linked service properties. TwilioLinkedServiceTypeProperties (required)

TwilioLinkedServiceTypeProperties

Name Description Value
password The auth token of Twilio service. SecretBase (required)
userName The Account SID of Twilio service. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

VerticaLinkedService

Name Description Value
type Type of linked service. 'Vertica' (required)
typeProperties Vertica linked service properties. VerticaLinkedServiceTypeProperties (required)

VerticaLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

WarehouseLinkedService

Name Description Value
type Type of linked service. 'Warehouse' (required)
typeProperties Microsoft Fabric Warehouse linked service properties. WarehouseLinkedServiceTypeProperties (required)

WarehouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric Warehouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

WebLinkedService

Name Description Value
type Type of linked service. 'Web' (required)
typeProperties Web linked service properties. WebLinkedServiceTypeProperties (required)

WebLinkedServiceTypeProperties

Name Description Value
url The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
authenticationType Set the object type Anonymous
Basic
ClientCertificate (required)

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). For Bicep, you can use the any() function.(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)

XeroLinkedService

Name Description Value
type Type of linked service. 'Xero' (required)
typeProperties Xero Service linked service properties. XeroLinkedServiceTypeProperties (required)

XeroLinkedServiceTypeProperties

Name Description Value
connectionProperties Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
consumerKey The consumer key associated with the Xero application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Xero server. (i.e. api.xero.com) For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

ZendeskLinkedService

Name Description Value
type Type of linked service. 'Zendesk' (required)
typeProperties Zendesk linked service properties. ZendeskLinkedServiceTypeProperties (required)

ZendeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Zendesk source. SecretBase
authenticationType The authentication type to use. 'Basic'
'Token' (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Zendesk source. SecretBase
url The url to connect Zendesk source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
userName The username of the Zendesk source. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ZohoLinkedService

Name Description Value
type Type of linked service. 'Zoho' (required)
typeProperties Zoho server linked service properties. ZohoLinkedServiceTypeProperties (required)

ZohoLinkedServiceTypeProperties

Name Description Value
accessToken The access token for Zoho authentication. SecretBase
connectionProperties Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object. For Bicep, you can use the any() function.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) For Bicep, you can use the any() function.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. For Bicep, you can use the any() function.
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. For Bicep, you can use the any() function.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. For Bicep, you can use the any() function.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy the Sports Analytics on Azure Architecture

Deploy to Azure
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

Deploy to Azure
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Create a Data Factory, copy from Salesforce to Blob

Deploy to Azure
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs
Bulk copy using Azure Data Factory

Deploy to Azure
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse.
Create a V2 data factory

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.
Create a V2 data factory (MySQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL.
Create a V2 data factory (PostGre)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL.
Create a V2 data factory (SQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database.
Create a V2 data factory (SQL On-prem)

Deploy to Azure
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage
Create a V2 data factory (Spark)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.

ARM template resource definition

The factories/linkedservices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/linkedservices resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/linkedservices",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ object ],
    "connectVia": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "IntegrationRuntimeReference"
    },
    "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": "string",
    "endpoint": {},
    "marketplaceID": {},
    "mwsAuthToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "secretKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "sellerID": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }

For AmazonRdsForOracle, use:

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

For AmazonRdsForSqlServer, use:

  "type": "AmazonRdsForSqlServer",
  "typeProperties": {
    "alwaysEncryptedSettings": {
      "alwaysEncryptedAkvAuthType": "string",
      "credential": {
        "referenceName": "string",
        "type": "CredentialReference",
        "{customized property}": {}
      },
      "servicePrincipalId": {},
      "servicePrincipalKey": {
        "type": "string"
        // For remaining properties, see SecretBase objects
      }
    },
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }

For AmazonRedshift, use:

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

For AmazonS3, use:

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

For AmazonS3Compatible, use:

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

For AppFigures, use:

  "type": "AppFigures",
  "typeProperties": {
    "clientKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }

For Asana, use:

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

For AzureBatch, use:

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

For AzureBlobFS, use:

  "type": "AzureBlobFS",
  "typeProperties": {
    "accountKey": {},
    "azureCloudType": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "sasToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "sasUri": {},
    "servicePrincipalCredential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalCredentialType": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "url": {}
  }

For AzureBlobStorage, use:

  "type": "AzureBlobStorage",
  "typeProperties": {
    "accountKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "accountKind": {},
    "authenticationType": "string",
    "azureCloudType": {},
    "connectionString": {},
    "containerUri": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "sasToken": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "sasUri": {},
    "serviceEndpoint": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }

For AzureDatabricks, use:

  "type": "AzureDatabricks",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "authentication": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "domain": {},
    "encryptedCredential": "string",
    "existingClusterId": {},
    "instancePoolId": {},
    "newClusterCustomTags": {},
    "newClusterDriverNodeType": {},
    "newClusterEnableElasticDisk": {},
    "newClusterInitScripts": {},
    "newClusterLogDestination": {},
    "newClusterNodeType": {},
    "newClusterNumOfWorker": {},
    "newClusterSparkConf": {
      "{customized property}": {}
    },
    "newClusterSparkEnvVars": {
      "{customized property}": {}
    },
    "newClusterVersion": {},
    "policyId": {},
    "workspaceResourceId": {}
  }

For AzureDatabricksDeltaLake, use:

  "type": "AzureDatabricksDeltaLake",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "clusterId": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "domain": {},
    "encryptedCredential": "string",
    "workspaceResourceId": {}
  }

For AzureDataExplorer, use:

  "type": "AzureDataExplorer",
  "typeProperties": {
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "database": {},
    "endpoint": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }

For AzureDataLakeAnalytics, use:

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

For AzureDataLakeStore, use:

  "type": "AzureDataLakeStore",
  "typeProperties": {
    "accountName": {},
    "azureCloudType": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "dataLakeStoreUri": {},
    "encryptedCredential": "string",
    "resourceGroupName": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "subscriptionId": {},
    "tenant": {}
  }

For AzureFileStorage, use:

  "type": "AzureFileStorage",
  "typeProperties": {
    "accountKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "connectionString": {},
    "encryptedCredential": "string",
    "fileShare": {},
    "host": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "sasToken": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "sasUri": {},
    "snapshot": {},
    "userId": {}
  }

For AzureFunction, use:

  "type": "AzureFunction",
  "typeProperties": {
    "authentication": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "functionAppUrl": {},
    "functionKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "resourceId": {}
  }

For AzureKeyVault, use:

  "type": "AzureKeyVault",
  "typeProperties": {
    "baseUrl": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    }
  }

For AzureMariaDB, use:

  "type": "AzureMariaDB",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "pwd": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For AzureML, use:

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

For AzureMLService, use:

  "type": "AzureMLService",
  "typeProperties": {
    "authentication": {},
    "encryptedCredential": "string",
    "mlWorkspaceName": {},
    "resourceGroupName": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "subscriptionId": {},
    "tenant": {}
  }

For AzureMySql, use:

  "type": "AzureMySql",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For AzurePostgreSql, use:

  "type": "AzurePostgreSql",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For AzureSearch, use:

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

For AzureSqlDatabase, use:

  "type": "AzureSqlDatabase",
  "typeProperties": {
    "alwaysEncryptedSettings": {
      "alwaysEncryptedAkvAuthType": "string",
      "credential": {
        "referenceName": "string",
        "type": "CredentialReference",
        "{customized property}": {}
      },
      "servicePrincipalId": {},
      "servicePrincipalKey": {
        "type": "string"
        // For remaining properties, see SecretBase objects
      }
    },
    "azureCloudType": {},
    "connectionString": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }

For AzureSqlDW, use:

  "type": "AzureSqlDW",
  "typeProperties": {
    "azureCloudType": {},
    "connectionString": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }

For AzureSqlMI, use:

  "type": "AzureSqlMI",
  "typeProperties": {
    "alwaysEncryptedSettings": {
      "alwaysEncryptedAkvAuthType": "string",
      "credential": {
        "referenceName": "string",
        "type": "CredentialReference",
        "{customized property}": {}
      },
      "servicePrincipalId": {},
      "servicePrincipalKey": {
        "type": "string"
        // For remaining properties, see SecretBase objects
      }
    },
    "azureCloudType": {},
    "connectionString": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {}
  }

For AzureStorage, use:

  "type": "AzureStorage",
  "typeProperties": {
    "accountKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "connectionString": {},
    "encryptedCredential": "string",
    "sasToken": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "sasUri": {}
  }

For AzureSynapseArtifacts, use:

  "type": "AzureSynapseArtifacts",
  "typeProperties": {
    "authentication": {},
    "endpoint": {},
    "workspaceResourceId": {}
  }

For AzureTableStorage, use:

  "type": "AzureTableStorage",
  "typeProperties": {
    "accountKey": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "connectionString": {},
    "encryptedCredential": "string",
    "sasToken": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "sasUri": {}
  }

For Cassandra, use:

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

For CommonDataServiceForApps, use:

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

For Concur, use:

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

For CosmosDb, use:

  "type": "CosmosDb",
  "typeProperties": {
    "accountEndpoint": {},
    "accountKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "azureCloudType": {},
    "connectionMode": "string",
    "connectionString": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "database": {},
    "encryptedCredential": "string",
    "servicePrincipalCredential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalCredentialType": {},
    "servicePrincipalId": {},
    "tenant": {}
  }

For CosmosDbMongoDbApi, use:

  "type": "CosmosDbMongoDbApi",
  "typeProperties": {
    "connectionString": {},
    "database": {},
    "isServerVersionAbove32": {}
  }

For Couchbase, use:

  "type": "Couchbase",
  "typeProperties": {
    "connectionString": {},
    "credString": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "encryptedCredential": "string"
  }

For CustomDataSource, use:

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

For Dataworld, use:

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

For Db2, use:

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

For Drill, use:

  "type": "Drill",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "pwd": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For Dynamics, use:

  "type": "Dynamics",
  "typeProperties": {
    "authenticationType": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "deploymentType": {},
    "encryptedCredential": "string",
    "hostName": {},
    "organizationName": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "port": {},
    "servicePrincipalCredential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalCredentialType": {},
    "servicePrincipalId": {},
    "serviceUri": {},
    "username": {}
  }

For DynamicsAX, use:

  "type": "DynamicsAX",
  "typeProperties": {
    "aadResourceId": {},
    "encryptedCredential": "string",
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "url": {}
  }

For DynamicsCrm, use:

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

For Eloqua, use:

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

For FileServer, use:

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

For FtpServer, use:

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

For GoogleAdWords, use:

  "type": "GoogleAdWords",
  "typeProperties": {
    "authenticationType": "string",
    "clientCustomerID": {},
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "connectionProperties": {},
    "developerToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "email": {},
    "encryptedCredential": "string",
    "googleAdsApiVersion": {},
    "keyFilePath": {},
    "loginCustomerID": {},
    "privateKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "refreshToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "supportLegacyDataTypes": {},
    "trustedCertPath": {},
    "useSystemTrustStore": {}
  }

For GoogleBigQuery, use:

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

For GoogleBigQueryV2, use:

  "type": "GoogleBigQueryV2",
  "typeProperties": {
    "authenticationType": "string",
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": "string",
    "keyFileContent": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "projectId": {},
    "refreshToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleCloudStorage, use:

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

For GoogleSheets, use:

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

For Greenplum, use:

  "type": "Greenplum",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "pwd": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For HBase, use:

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

For Hdfs, use:

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

For HDInsight, use:

  "type": "HDInsight",
  "typeProperties": {
    "clusterUri": {},
    "encryptedCredential": "string",
    "fileSystem": {},
    "hcatalogLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "isEspEnabled": {},
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }

For HDInsightOnDemand, use:

  "type": "HDInsightOnDemand",
  "typeProperties": {
    "additionalLinkedServiceNames": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ],
    "clusterNamePrefix": {},
    "clusterPassword": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "clusterResourceGroup": {},
    "clusterSize": {},
    "clusterSshPassword": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "clusterSshUserName": {},
    "clusterType": {},
    "clusterUserName": {},
    "coreConfiguration": {},
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "dataNodeSize": {},
    "encryptedCredential": "string",
    "hBaseConfiguration": {},
    "hcatalogLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "hdfsConfiguration": {},
    "headNodeSize": {},
    "hiveConfiguration": {},
    "hostSubscriptionId": {},
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "mapReduceConfiguration": {},
    "oozieConfiguration": {},
    "scriptActions": [
      {
        "name": "string",
        "parameters": "string",
        "roles": {},
        "uri": "string"
      }
    ],
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "sparkVersion": {},
    "stormConfiguration": {},
    "subnetName": {},
    "tenant": {},
    "timeToLive": {},
    "version": {},
    "virtualNetworkId": {},
    "yarnConfiguration": {},
    "zookeeperNodeSize": {}
  }

For Hive, use:

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

For HttpServer, use:

  "type": "HttpServer",
  "typeProperties": {
    "authenticationType": "string",
    "authHeaders": {},
    "certThumbprint": {},
    "embeddedCertData": {},
    "enableServerCertificateValidation": {},
    "encryptedCredential": "string",
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "url": {},
    "userName": {}
  }

For Hubspot, use:

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

For Impala, use:

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

For Informix, use:

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

For Jira, use:

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

For LakeHouse, use:

  "type": "LakeHouse",
  "typeProperties": {
    "artifactId": {},
    "encryptedCredential": "string",
    "servicePrincipalCredential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalCredentialType": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "workspaceId": {}
  }

For Magento, use:

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

For MariaDB, use:

  "type": "MariaDB",
  "typeProperties": {
    "connectionString": {},
    "database": {},
    "driverVersion": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "port": {},
    "server": {},
    "username": {}
  }

For Marketo, use:

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

For MicrosoftAccess, use:

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

For MongoDb, use:

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

For MongoDbAtlas, use:

  "type": "MongoDbAtlas",
  "typeProperties": {
    "connectionString": {},
    "database": {},
    "driverVersion": {}
  }

For MongoDbV2, use:

  "type": "MongoDbV2",
  "typeProperties": {
    "connectionString": {},
    "database": {}
  }

For MySql, use:

  "type": "MySql",
  "typeProperties": {
    "connectionString": {},
    "database": {},
    "driverVersion": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "port": {},
    "server": {},
    "sslMode": {},
    "username": {},
    "useSystemTrustStore": {}
  }

For Netezza, use:

  "type": "Netezza",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "pwd": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For OData, use:

  "type": "OData",
  "typeProperties": {
    "aadResourceId": {},
    "aadServicePrincipalCredentialType": "string",
    "authenticationType": "string",
    "authHeaders": {},
    "azureCloudType": {},
    "encryptedCredential": "string",
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalEmbeddedCert": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalEmbeddedCertPassword": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "url": {},
    "userName": {}
  }

For Odbc, use:

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

For Office365, use:

  "type": "Office365",
  "typeProperties": {
    "encryptedCredential": "string",
    "office365TenantId": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalTenantId": {}
  }

For Oracle, use:

  "type": "Oracle",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For OracleCloudStorage, use:

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

For OracleServiceCloud, use:

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

For Paypal, use:

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

For Phoenix, use:

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

For PostgreSql, use:

  "type": "PostgreSql",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For PostgreSqlV2, use:

  "type": "PostgreSqlV2",
  "typeProperties": {
    "commandTimeout": {},
    "connectionTimeout": {},
    "database": {},
    "encoding": {},
    "encryptedCredential": "string",
    "logParameters": {},
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    },
    "pooling": {},
    "port": {},
    "readBufferSize": {},
    "schema": {},
    "server": {},
    "sslCertificate": {},
    "sslKey": {},
    "sslMode": {},
    "sslPassword": {},
    "timezone": {},
    "trustServerCertificate": {},
    "username": {}
  }

For Presto, use:

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

For Quickbase, use:

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

For QuickBooks, use:

  "type": "QuickBooks",
  "typeProperties": {
    "accessToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "accessTokenSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "companyId": {},
    "connectionProperties": {},
    "consumerKey": {},
    "consumerSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": "string",
    "endpoint": {},
    "useEncryptedEndpoints": {}
  }

For Responsys, use:

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

For RestService, use:

  "type": "RestService",
  "typeProperties": {
    "aadResourceId": {},
    "authenticationType": "string",
    "authHeaders": {},
    "azureCloudType": {},
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "credential": {
      "referenceName": "string",
      "type": "CredentialReference",
      "{customized property}": {}
    },
    "enableServerCertificateValidation": {},
    "encryptedCredential": "string",
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "resource": {},
    "scope": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "tokenEndpoint": {},
    "url": {},
    "userName": {}
  }

For Salesforce, use:

  "type": "Salesforce",
  "typeProperties": {
    "apiVersion": {},
    "encryptedCredential": "string",
    "environmentUrl": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "securityToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "username": {}
  }

For SalesforceMarketingCloud, use:

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

For SalesforceServiceCloud, use:

  "type": "SalesforceServiceCloud",
  "typeProperties": {
    "apiVersion": {},
    "encryptedCredential": "string",
    "environmentUrl": {},
    "extendedProperties": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "securityToken": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "username": {}
  }

For SalesforceServiceCloudV2, use:

  "type": "SalesforceServiceCloudV2",
  "typeProperties": {
    "apiVersion": {},
    "authenticationType": {},
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": "string",
    "environmentUrl": {}
  }

For SalesforceV2, use:

  "type": "SalesforceV2",
  "typeProperties": {
    "apiVersion": {},
    "authenticationType": {},
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": "string",
    "environmentUrl": {}
  }

For SapBW, use:

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

For SapCloudForCustomer, use:

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

For SapEcc, use:

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

For SapHana, use:

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

For SapOdp, use:

  "type": "SapOdp",
  "typeProperties": {
    "clientId": {},
    "encryptedCredential": "string",
    "language": {},
    "logonGroup": {},
    "messageServer": {},
    "messageServerService": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "sncLibraryPath": {},
    "sncMode": {},
    "sncMyName": {},
    "sncPartnerName": {},
    "sncQop": {},
    "subscriberName": {},
    "systemId": {},
    "systemNumber": {},
    "userName": {},
    "x509CertificatePath": {}
  }

For SapOpenHub, use:

  "type": "SapOpenHub",
  "typeProperties": {
    "clientId": {},
    "encryptedCredential": "string",
    "language": {},
    "logonGroup": {},
    "messageServer": {},
    "messageServerService": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "systemId": {},
    "systemNumber": {},
    "userName": {}
  }

For SapTable, use:

  "type": "SapTable",
  "typeProperties": {
    "clientId": {},
    "encryptedCredential": "string",
    "language": {},
    "logonGroup": {},
    "messageServer": {},
    "messageServerService": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "server": {},
    "sncLibraryPath": {},
    "sncMode": {},
    "sncMyName": {},
    "sncPartnerName": {},
    "sncQop": {},
    "systemId": {},
    "systemNumber": {},
    "userName": {}
  }

For ServiceNow, use:

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

For ServiceNowV2, use:

  "type": "ServiceNowV2",
  "typeProperties": {
    "authenticationType": "string",
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "encryptedCredential": "string",
    "endpoint": {},
    "grantType": {},
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "username": {}
  }

For Sftp, use:

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

For SharePointOnlineList, use:

  "type": "SharePointOnlineList",
  "typeProperties": {
    "encryptedCredential": "string",
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "siteUrl": {},
    "tenantId": {}
  }

For Shopify, use:

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

For Smartsheet, use:

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

For Snowflake, use:

  "type": "Snowflake",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "password": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For SnowflakeV2, use:

  "type": "SnowflakeV2",
  "typeProperties": {
    "accountIdentifier": {},
    "authenticationType": "string",
    "clientId": {},
    "clientSecret": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "database": {},
    "encryptedCredential": "string",
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "privateKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "privateKeyPassphrase": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "scope": {},
    "tenantId": {},
    "user": {},
    "warehouse": {}
  }

For Spark, use:

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

For SqlServer, use:

  "type": "SqlServer",
  "typeProperties": {
    "alwaysEncryptedSettings": {
      "alwaysEncryptedAkvAuthType": "string",
      "credential": {
        "referenceName": "string",
        "type": "CredentialReference",
        "{customized property}": {}
      },
      "servicePrincipalId": {},
      "servicePrincipalKey": {
        "type": "string"
        // For remaining properties, see SecretBase objects
      }
    },
    "connectionString": {},
    "encryptedCredential": "string",
    "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
    },
    "connectionProperties": {},
    "encryptedCredential": "string",
    "host": {},
    "redirectUri": {},
    "useEncryptedEndpoints": {},
    "useHostVerification": {},
    "usePeerVerification": {}
  }

For Sybase, use:

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

For TeamDesk, use:

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

For Teradata, use:

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

For Twilio, use:

  "type": "Twilio",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "userName": {}
  }

For Vertica, use:

  "type": "Vertica",
  "typeProperties": {
    "connectionString": {},
    "encryptedCredential": "string",
    "pwd": {
      "secretName": {},
      "secretVersion": {},
      "store": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "type": "string"
    }
  }

For Warehouse, use:

  "type": "Warehouse",
  "typeProperties": {
    "artifactId": {},
    "encryptedCredential": "string",
    "endpoint": {},
    "servicePrincipalCredential": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "servicePrincipalCredentialType": {},
    "servicePrincipalId": {},
    "servicePrincipalKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "tenant": {},
    "workspaceId": {}
  }

For Web, use:

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

For Xero, use:

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

For Zendesk, use:

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

For Zoho, use:

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

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  "type": "AzureKeyVaultSecret",
  "secretName": {},
  "secretVersion": {},
  "store": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  }

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

factories/linkedservices

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/linkedservices'
apiVersion The resource api version '2018-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
properties Properties of linked service. LinkedService (required)

LinkedService

Name Description Value
annotations List of tags that can be used for describing the linked service. any[]
connectVia The integration runtime reference. IntegrationRuntimeReference
description Linked service description. string
parameters Parameters for linked service. ParameterDefinitionSpecification
type Set the object type AmazonMWS
AmazonRdsForOracle
AmazonRdsForSqlServer
AmazonRedshift
AmazonS3
AmazonS3Compatible
AppFigures
Asana
AzureBatch
AzureBlobFS
AzureBlobStorage
AzureDatabricks
AzureDatabricksDeltaLake
AzureDataExplorer
AzureDataLakeAnalytics
AzureDataLakeStore
AzureFileStorage
AzureFunction
AzureKeyVault
AzureMariaDB
AzureML
AzureMLService
AzureMySql
AzurePostgreSql
AzureSearch
AzureSqlDatabase
AzureSqlDW
AzureSqlMI
AzureStorage
AzureSynapseArtifacts
AzureTableStorage
Cassandra
CommonDataServiceForApps
Concur
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomDataSource
Dataworld
Db2
Drill
Dynamics
DynamicsAX
DynamicsCrm
Eloqua
FileServer
FtpServer
GoogleAdWords
GoogleBigQuery
GoogleBigQueryV2
GoogleCloudStorage
GoogleSheets
Greenplum
HBase
Hdfs
HDInsight
HDInsightOnDemand
Hive
HttpServer
Hubspot
Impala
Informix
Jira
LakeHouse
Magento
MariaDB
Marketo
MicrosoftAccess
MongoDb
MongoDbAtlas
MongoDbV2
MySql
Netezza
OData
Odbc
Office365
Oracle
OracleCloudStorage
OracleServiceCloud
Paypal
Phoenix
PostgreSql
PostgreSqlV2
Presto
Quickbase
QuickBooks
Responsys
RestService
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SalesforceServiceCloudV2
SalesforceV2
SapBW
SapCloudForCustomer
SapEcc
SapHana
SapOdp
SapOpenHub
SapTable
ServiceNow
ServiceNowV2
Sftp
SharePointOnlineList
Shopify
Smartsheet
Snowflake
SnowflakeV2
Spark
SqlServer
Square
Sybase
TeamDesk
Teradata
Twilio
Vertica
Warehouse
Web
Xero
Zendesk
Zoho (required)

IntegrationRuntimeReference

Name Description Value
parameters Arguments for integration runtime. ParameterValueSpecification
referenceName Reference integration runtime name. string (required)
type Type of integration runtime. 'IntegrationRuntimeReference' (required)

ParameterValueSpecification

Name Description Value
{customized property}

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter.
type Parameter type. 'Array'
'Bool'
'Float'
'Int'
'Object'
'SecureString'
'String' (required)

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)
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)
mwsAuthToken The Amazon MWS authentication token. SecretBase
secretKey The secret key used to access data. SecretBase
sellerID The Amazon seller ID.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

SecretBase

Name Description Value
type Set the object type AzureKeyVaultSecret
SecureString (required)

AzureKeyVaultSecretReference

Name Description Value
secretName The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
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).
store The Azure Key Vault linked service reference. LinkedServiceReference (required)
type Type of the secret. string (required)

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference' (required)

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

AmazonRdsForOracleLinkedService

Name Description Value
type Type of linked service. 'AmazonRdsForOracle' (required)
typeProperties AmazonRdsForOracle database linked service properties. AmazonRdsForLinkedServiceTypeProperties (required)

AmazonRdsForLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase

AmazonRdsForSqlServerLinkedService

Name Description Value
type Type of linked service. 'AmazonRdsForSqlServer' (required)
typeProperties Amazon RDS for SQL Server linked service properties. AmazonRdsForSqlServerLinkedServiceTypeProperties (required)

AmazonRdsForSqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

SqlAlwaysEncryptedProperties

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

CredentialReference

Name Description Value
referenceName Reference credential name. string (required)
type Credential reference type. 'CredentialReference' (required)
{customized property}

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Amazon Redshift source. SecretBase
port The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).
server The name of the Amazon Redshift server. Type: string (or Expression with resultType string).
username The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

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).
authenticationType The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Amazon S3 Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
sessionToken The session token for the S3 temporary security credential. SecretBase

AmazonS3CompatibleLinkedService

Name Description Value
type Type of linked service. 'AmazonS3Compatible' (required)
typeProperties Amazon S3 Compatible linked service properties. AmazonS3CompatibleLinkedServiceTypeProperties (required)

AmazonS3CompatibleLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
forcePathStyle If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean).
secretAccessKey The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

AppFiguresLinkedService

Name Description Value
type Type of linked service. 'AppFigures' (required)
typeProperties AppFigures linked service properties. AppFiguresLinkedServiceTypeProperties (required)

AppFiguresLinkedServiceTypeProperties

Name Description Value
clientKey The client key for the AppFigures source. SecretBase (required)
password The password of the AppFigures source. SecretBase (required)
userName The username of the Appfigures source. Type: string (or Expression with resultType string).

AsanaLinkedService

Name Description Value
type Type of linked service. 'Asana' (required)
typeProperties Asana linked service properties. AsanaLinkedServiceTypeProperties (required)

AsanaLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Asana source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

AzureBatchLinkedService

Name Description Value
type Type of linked service. 'AzureBatch' (required)
typeProperties Azure Batch linked service properties. AzureBatchLinkedServiceTypeProperties (required)

AzureBatchLinkedServiceTypeProperties

Name Description Value
accessKey The Azure Batch account access key. SecretBase
accountName The Azure Batch account name. Type: string (or Expression with resultType string).
batchUri The Azure Batch URI. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
linkedServiceName The Azure Storage linked service reference. LinkedServiceReference (required)
poolName The Azure Batch pool name. Type: string (or Expression with resultType string).

AzureBlobFSLinkedService

Name Description Value
type Type of linked service. 'AzureBlobFS' (required)
typeProperties Azure Data Lake Storage Gen2 linked service properties. AzureBlobFSLinkedServiceTypeProperties (required)

AzureBlobFSLinkedServiceTypeProperties

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

AzureBlobStorageLinkedService

Name Description Value
type Type of linked service. 'AzureBlobStorage' (required)
typeProperties Azure Blob Storage linked service properties. AzureBlobStorageLinkedServiceTypeProperties (required)

AzureBlobStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
accountKind Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).
authenticationType The type used for authentication. Type: string. 'AccountKey'
'Anonymous'
'Msi'
'SasUri'
'ServicePrincipal'
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
containerUri Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
serviceEndpoint Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
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).

AzureDatabricksLinkedService

Name Description Value
type Type of linked service. 'AzureDatabricks' (required)
typeProperties Azure Databricks linked service properties. AzureDatabricksLinkedServiceTypeProperties (required)

AzureDatabricksLinkedServiceTypeProperties

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

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property}

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property}

AzureDatabricksDeltaLakeLinkedService

Name Description Value
type Type of linked service. 'AzureDatabricksDeltaLake' (required)
typeProperties Azure Databricks Delta Lake linked service properties. AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required)

AzureDatabricksDetltaLakeLinkedServiceTypeProperties

Name Description Value
accessToken Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. SecretBase
clusterId The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
domain {REGION}.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
workspaceResourceId Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

AzureDataExplorerLinkedService

Name Description Value
type Type of linked service. 'AzureDataExplorer' (required)
typeProperties Azure Data Explorer (Kusto) linked service properties. AzureDataExplorerLinkedServiceTypeProperties (required)

AzureDataExplorerLinkedServiceTypeProperties

Name Description Value
credential The credential reference containing authentication information. CredentialReference
database Database name for connection. Type: string (or Expression with resultType string).
endpoint The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://{clusterName}.{regionName}.kusto.windows.net. Type: string (or Expression with resultType string)
servicePrincipalId The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against Kusto. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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).
dataLakeAnalyticsUri Azure Data Lake Analytics URI Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).
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).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
dataLakeStoreUri Data Lake Store service URI. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).
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).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

AzureFileStorageLinkedService

Name Description Value
type Type of linked service. 'AzureFileStorage' (required)
typeProperties Azure File Storage linked service properties. AzureFileStorageLinkedServiceTypeProperties (required)

AzureFileStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileShare The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
host Host name of the server. Type: string (or Expression with resultType string).
password Password to logon the server. SecretBase
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
snapshot The azure file share snapshot version. Type: string (or Expression with resultType string).
userId User ID to logon the server. Type: string (or Expression with resultType string).

AzureFunctionLinkedService

Name Description Value
type Type of linked service. 'AzureFunction' (required)
typeProperties Azure Function linked service properties. AzureFunctionLinkedServiceTypeProperties (required)

AzureFunctionLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
functionAppUrl The endpoint of the Azure Function App. URL will be in the format https://{accountName}.azurewebsites.net. Type: string (or Expression with resultType string).
functionKey Function or Host key for Azure Function App. SecretBase
resourceId Allowed token audiences for azure function. Type: string (or Expression with resultType string).

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).
credential The credential reference containing authentication information. CredentialReference

AzureMariaDBLinkedService

Name Description Value
type Type of linked service. 'AzureMariaDB' (required)
typeProperties Azure Database for MariaDB linked service properties. AzureMariaDBLinkedServiceTypeProperties (required)

AzureMariaDBLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureMLLinkedService

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

AzureMLLinkedServiceTypeProperties

Name Description Value
apiKey The API key for accessing the Azure ML model endpoint. SecretBase (required)
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlEndpoint The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
updateResourceEndpoint The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

AzureMLServiceLinkedService

Name Description Value
type Type of linked service. 'AzureMLService' (required)
typeProperties Azure ML Service linked service properties. AzureMLServiceLinkedServiceTypeProperties (required)

AzureMLServiceLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlWorkspaceName Azure ML Service workspace name. Type: string (or Expression with resultType string).
resourceGroupName Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. SecretBase
subscriptionId Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzurePostgreSqlLinkedService

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

AzurePostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureSearchLinkedService

Name Description Value
type Type of linked service. 'AzureSearch' (required)
typeProperties Windows Azure Search Service linked service properties. AzureSearchLinkedServiceTypeProperties (required)

AzureSearchLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
key Admin Key for Azure Search service SecretBase
url URL for Azure Search service. Type: string (or Expression with resultType string).

AzureSqlDatabaseLinkedService

Name Description Value
type Type of linked service. 'AzureSqlDatabase' (required)
typeProperties Azure SQL Database linked service properties. AzureSqlDatabaseLinkedServiceTypeProperties (required)

AzureSqlDatabaseLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
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).

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
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
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).

AzureSqlMILinkedService

Name Description Value
type Type of linked service. 'AzureSqlMI' (required)
typeProperties Azure SQL Managed Instance linked service properties. AzureSqlMILinkedServiceTypeProperties (required)

AzureSqlMILinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against Azure SQL Managed Instance. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

AzureStorageLinkedService

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

AzureStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

AzureSynapseArtifactsLinkedService

Name Description Value
type Type of linked service. 'AzureSynapseArtifacts' (required)
typeProperties Azure Synapse Analytics (Artifacts) linked service properties. AzureSynapseArtifactsLinkedServiceTypeProperties (required)

AzureSynapseArtifactsLinkedServiceTypeProperties

Name Description Value
authentication Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string).
endpoint https://{workspacename}.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string).
workspaceResourceId The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string).

AzureTableStorageLinkedService

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

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name for connection. Type: string (or Expression with resultType string).
password Password for authentication. SecretBase
port The port for the connection. Type: integer (or Expression with resultType integer).
username Username for authentication. Type: string (or Expression with resultType string).

CommonDataServiceForAppsLinkedService

Name Description Value
type Type of linked service. 'CommonDataServiceForApps' (required)
typeProperties Common Data Service for Apps linked service properties. CommonDataServiceForAppsLinkedServiceTypeProperties (required)

CommonDataServiceForAppsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
deploymentType The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
organizationName The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).
password Password to access the Common Data Service for Apps instance. SecretBase
port The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
serviceUri The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
username User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).

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.
connectionProperties Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password corresponding to the user name that you provided in the username field. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name that you use to access Concur Service.

CosmosDbLinkedService

Name Description Value
type Type of linked service. 'CosmosDb' (required)
typeProperties CosmosDB linked service properties. CosmosDbLinkedServiceTypeProperties (required)

CosmosDbLinkedServiceTypeProperties

Name Description Value
accountEndpoint The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)
accountKey The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. SecretBase
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionMode The connection mode used to access CosmosDB account. Type: string. 'Direct'
'Gateway'
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
database The name of the database. Type: string (or Expression with resultType string)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

CosmosDbMongoDbApiLinkedService

Name Description Value
type Type of linked service. 'CosmosDbMongoDbApi' (required)
typeProperties CosmosDB (MongoDB API) linked service properties. CosmosDbMongoDbApiLinkedServiceTypeProperties (required)

CosmosDbMongoDbApiLinkedServiceTypeProperties

Name Description Value
connectionString The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).
isServerVersionAbove32 Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

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.
credString The Azure key vault secret reference of credString in connection string. AzureKeyVaultSecretReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

CustomDataSourceLinkedService

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

DataworldLinkedService

Name Description Value
type Type of linked service. 'Dataworld' (required)
typeProperties Dataworld linked service properties. DataworldLinkedServiceTypeProperties (required)

DataworldLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Dataworld source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

Db2LinkedService

Name Description Value
type Type of linked service. 'Db2' (required)
typeProperties DB2 linked service properties. Db2LinkedServiceTypeProperties (required)

Db2LinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. 'Basic'
certificateCommonName Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
connectionString The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
database Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. string
packageCollection Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
password Password for authentication. SecretBase
server Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
username Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

DynamicsLinkedService

Name Description Value
type Type of linked service. 'Dynamics' (required)
typeProperties Dynamics linked service properties. DynamicsLinkedServiceTypeProperties (required)

DynamicsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
deploymentType The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
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).
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.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
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).
username User name to access the Dynamics instance. Type: string (or Expression with resultType string).

DynamicsAXLinkedService

Name Description Value
type Type of linked service. 'DynamicsAX' (required)
typeProperties Dynamics AX linked service properties. DynamicsAXLinkedServiceTypeProperties (required)

DynamicsAXLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string). SecretBase (required)
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).
url The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.

DynamicsCrmLinkedService

Name Description Value
type Type of linked service. 'DynamicsCrm' (required)
typeProperties Dynamics CRM linked service properties. DynamicsCrmLinkedServiceTypeProperties (required)

DynamicsCrmLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
deploymentType The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
organizationName The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).
password Password to access the Dynamics CRM instance. SecretBase
port The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
serviceUri The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
username User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).

EloquaLinkedService

Name Description Value
type Type of linked service. 'Eloqua' (required)
typeProperties Eloqua server linked service properties. EloquaLinkedServiceTypeProperties (required)

EloquaLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Eloqua server. (i.e. eloqua.example.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)

FileServerLinkedService

Name Description Value
type Type of linked service. 'FileServer' (required)
typeProperties File system linked service properties. FileServerLinkedServiceTypeProperties (required)

FileServerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the server. Type: string (or Expression with resultType string).
password Password to logon the server. SecretBase
userId User ID to logon the server. Type: string (or Expression with resultType string).

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).
enableSsl If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the FTP server. Type: string (or Expression with resultType string).
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.
userName Username to logon the FTP server. Type: string (or Expression with resultType string).

GoogleAdWordsLinkedService

Name Description Value
type Type of linked service. 'GoogleAdWords' (required)
typeProperties Google AdWords service linked service properties. GoogleAdWordsLinkedServiceTypeProperties (required)

GoogleAdWordsLinkedServiceTypeProperties

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

GoogleBigQueryLinkedService

Name Description Value
type Type of linked service. 'GoogleBigQuery' (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryLinkedServiceTypeProperties (required)

GoogleBigQueryLinkedServiceTypeProperties

Name Description Value
additionalProjects A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string).
authenticationType The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. 'ServiceAuthentication'
'UserAuthentication' (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
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. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFilePath The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
project The default BigQuery project to query against. Type: string (or Expression with resultType string).
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase
requestGoogleDriveScope Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string).
trustedCertPath The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean).

GoogleBigQueryV2LinkedService

Name Description Value
type Type of linked service. 'GoogleBigQueryV2' (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryV2LinkedServiceTypeProperties (required)

GoogleBigQueryV2LinkedServiceTypeProperties

Name Description Value
authenticationType The OAuth 2.0 authentication mechanism used for authentication. 'ServiceAuthentication'
'UserAuthentication' (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
clientSecret The client secret of the google application used to acquire the refresh token. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFileContent The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). SecretBase
projectId The default BigQuery project id to query against. Type: string (or Expression with resultType string).
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase

GoogleCloudStorageLinkedService

Name Description Value
type Type of linked service. 'GoogleCloudStorage' (required)
typeProperties Google Cloud Storage linked service properties. GoogleCloudStorageLinkedServiceTypeProperties (required)

GoogleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

GoogleSheetsLinkedService

Name Description Value
type Type of linked service. 'GoogleSheets' (required)
typeProperties GoogleSheets linked service properties. GoogleSheetsLinkedServiceTypeProperties (required)

GoogleSheetsLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the GoogleSheets source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

GreenplumLinkedService

Name Description Value
type Type of linked service. 'Greenplum' (required)
typeProperties Greenplum Database linked service properties. GreenplumLinkedServiceTypeProperties (required)

GreenplumLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

HBaseLinkedService

Name Description Value
type Type of linked service. 'HBase' (required)
typeProperties HBase server linked service properties. HBaseLinkedServiceTypeProperties (required)

HBaseLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the HBase server. (i.e. 192.168.222.160)
httpPath The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)
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.
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.
username The user name used to connect to the HBase instance.

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Windows authentication. SecretBase
url The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).
userName User name for Windows authentication. Type: string (or Expression with resultType string).

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileSystem Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).
hcatalogLinkedServiceName A reference to the Azure SQL linked service that points to the HCatalog database. LinkedServiceReference
isEspEnabled Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.
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).

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).
clusterPassword The password to access the cluster. SecretBase
clusterResourceGroup The resource group where the cluster belongs. Type: string (or Expression with resultType string).
clusterSize Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).
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).
clusterType The cluster type. Type: string (or Expression with resultType string).
clusterUserName The username to access the cluster. Type: string (or Expression with resultType string).
coreConfiguration Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
credential The credential reference containing authentication information. CredentialReference
dataNodeSize Specifies the size of the data node for the HDInsight cluster.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hBaseConfiguration Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
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.
headNodeSize Specifies the size of the head node for the HDInsight cluster.
hiveConfiguration Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
hostSubscriptionId The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
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.
oozieConfiguration Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
scriptActions Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. ScriptAction[]
servicePrincipalId The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
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).
stormConfiguration Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
subnetName The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).
tenant The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
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).
version Version of the HDInsight cluster.  Type: string (or Expression with resultType string).
virtualNetworkId The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
yarnConfiguration Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
zookeeperNodeSize Specifies the size of the Zoo Keeper node for the HDInsight cluster.

ScriptAction

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

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).
httpPath The partial URL corresponding to the Hive server.
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.
serverType The type of Hive server. 'HiveServer1'
'HiveServer2'
'HiveThriftServer'
serviceDiscoveryMode true to indicate using the ZooKeeper service, false not.
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.
useNativeQuery Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
username The user name that you use to access Hive Server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
zooKeeperNameSpace The namespace on ZooKeeper under which Hive Server 2 nodes are added.

HttpLinkedService

Name Description Value
type Type of linked service. 'HttpServer' (required)
typeProperties Properties specific to this linked service type. HttpLinkedServiceTypeProperties (required)

HttpLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the HTTP server. 'Anonymous'
'Basic'
'ClientCertificate'
'Digest'
'Windows'
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
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).
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).
enableServerCertificateValidation If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. SecretBase
url The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).
userName User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

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.
clientSecret The client secret associated with your Hubspot application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
refreshToken The refresh token obtained when initially authenticating your OAuth integration. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Impala server. (i.e. 192.168.222.160)
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.
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.
username The user name used to access the Impala server. The default value is anonymous when using SASLUsername.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

InformixLinkedService

Name Description Value
type Type of linked service. 'Informix' (required)
typeProperties Informix linked service properties. InformixLinkedServiceTypeProperties (required)

InformixLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

JiraLinkedService

Name Description Value
type Type of linked service. 'Jira' (required)
typeProperties Jira Service linked service properties. JiraLinkedServiceTypeProperties (required)

JiraLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Jira service. (e.g. jira.example.com)
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.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name that you use to access Jira Service.

LakeHouseLinkedService

Name Description Value
type Type of linked service. 'LakeHouse' (required)
typeProperties Microsoft Fabric LakeHouse linked service properties. LakeHouseLinkedServiceTypeProperties (required)

LakeHouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string).
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric LakeHouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).

MagentoLinkedService

Name Description Value
type Type of linked service. 'Magento' (required)
typeProperties Magento server linked service properties. MagentoLinkedServiceTypeProperties (required)

MagentoLinkedServiceTypeProperties

Name Description Value
accessToken The access token from Magento. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Magento instance. (i.e. 192.168.222.110/magento3)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
database Database name for connection. Type: string.
driverVersion The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer.
server Server name for connection. Type: string.
username Username for authentication. Type: string.

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.
clientSecret The client secret of your Marketo service. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

MicrosoftAccessLinkedService

Name Description Value
type Type of linked service. 'MicrosoftAccess' (required)
typeProperties Microsoft Access linked service properties. MicrosoftAccessLinkedServiceTypeProperties (required)

MicrosoftAccessLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

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).
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).
databaseName The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
port The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
server The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

MongoDbAtlasLinkedService

Name Description Value
type Type of linked service. 'MongoDbAtlas' (required)
typeProperties MongoDB Atlas linked service properties. MongoDbAtlasLinkedServiceTypeProperties (required)

MongoDbAtlasLinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).
driverVersion The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string).

MongoDbV2LinkedService

Name Description Value
type Type of linked service. 'MongoDbV2' (required)
typeProperties MongoDB linked service properties. MongoDbV2LinkedServiceTypeProperties (required)

MongoDbV2LinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

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. Type: string, SecureString or AzureKeyVaultSecretReference.
database Database name for connection. Type: string.
driverVersion The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer.
server Server name for connection. Type: string.
sslMode SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.
username Username for authentication. Type: string.
useSystemTrustStore Use system trust store for connection. Type: integer. 0: enable, 1: disable.

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

ODataLinkedService

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

ODataLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
aadServicePrincipalCredentialType Specify the credential type (key or cert) is used for service principal. 'ServicePrincipalCert'
'ServicePrincipalKey'
authenticationType Type of authentication used to connect to the OData service. 'AadServicePrincipal'
'Anonymous'
'Basic'
'ManagedServiceIdentity'
'Windows'
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password of the OData service. SecretBase
servicePrincipalEmbeddedCert Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
servicePrincipalEmbeddedCertPassword Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). SecretBase
servicePrincipalId Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
url The URL of the OData service endpoint. Type: string (or Expression with resultType string).
userName User name of the OData service. Type: string (or Expression with resultType string).

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).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

Office365LinkedService

Name Description Value
type Type of linked service. 'Office365' (required)
typeProperties Office365 linked service properties. Office365LinkedServiceTypeProperties (required)

Office365LinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
office365TenantId Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the application's key. SecretBase (required)
servicePrincipalTenantId Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

OracleCloudStorageLinkedService

Name Description Value
type Type of linked service. 'OracleCloudStorage' (required)
typeProperties Oracle Cloud Storage linked service properties. OracleCloudStorageLinkedServiceTypeProperties (required)

OracleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

OracleServiceCloudLinkedService

Name Description Value
type Type of linked service. 'OracleServiceCloud' (required)
typeProperties Oracle Service Cloud linked service properties. OracleServiceCloudLinkedServiceTypeProperties (required)

OracleServiceCloudLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Oracle Service Cloud instance.
password The password corresponding to the user name that you provided in the username key. SecretBase (required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).
username The user name that you use to access Oracle Service Cloud server.

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.
clientSecret The client secret associated with your PayPal application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)
httpPath The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.
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.
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.
username The user name used to connect to the Phoenix server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

PostgreSqlLinkedService

Name Description Value
type Type of linked service. 'PostgreSql' (required)
typeProperties PostgreSQL linked service properties. PostgreSqlLinkedServiceTypeProperties (required)

PostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

PostgreSqlV2LinkedService

Name Description Value
type Type of linked service. 'PostgreSqlV2' (required)
typeProperties PostgreSQLV2 linked service properties. PostgreSqlV2LinkedServiceTypeProperties (required)

PostgreSqlV2LinkedServiceTypeProperties

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

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
authenticationType The authentication mechanism used to connect to the Presto server. 'Anonymous'
'LDAP' (required)
catalog The catalog context for all request against the server.
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Presto server. (i.e. 192.168.222.160)
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.
serverVersion The version of the Presto server. (i.e. 0.148-t)
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.
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.
username The user name used to connect to the Presto server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

QuickbaseLinkedService

Name Description Value
type Type of linked service. 'Quickbase' (required)
typeProperties Quickbase linked service properties. QuickbaseLinkedServiceTypeProperties (required)

QuickbaseLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
url The url to connect Quickbase source. Type: string (or Expression with resultType string).
userToken The user token for the Quickbase source. SecretBase (required)

QuickBooksLinkedService

Name Description Value
type Type of linked service. 'QuickBooks' (required)
typeProperties QuickBooks server linked service properties. QuickBooksLinkedServiceTypeProperties (required)

QuickBooksLinkedServiceTypeProperties

Name Description Value
accessToken The access token for OAuth 1.0 authentication. SecretBase
accessTokenSecret The access token secret for OAuth 1.0 authentication. SecretBase
companyId The company ID of the QuickBooks company to authorize.
connectionProperties Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.
consumerKey The consumer key for OAuth 1.0 authentication.
consumerSecret The consumer secret for OAuth 1.0 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

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).
clientSecret The client secret associated with the Responsys application. Type: string (or Expression with resultType string). SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Responsys server.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).

RestServiceLinkedService

Name Description Value
type Type of linked service. 'RestService' (required)
typeProperties Rest Service linked service properties. RestServiceLinkedServiceTypeProperties (required)

RestServiceLinkedServiceTypeProperties

Name Description Value
aadResourceId The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
authenticationType Type of authentication used to connect to the REST service. 'AadServicePrincipal'
'Anonymous'
'Basic'
'ManagedServiceIdentity'
'OAuth2ClientCredential' (required)
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
clientId The client ID associated with your application. Type: string (or Expression with resultType string).
clientSecret The client secret associated with your application. SecretBase
credential The credential reference containing authentication information. CredentialReference
enableServerCertificateValidation Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password used in Basic authentication type. SecretBase
resource The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
scope The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
servicePrincipalId The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
servicePrincipalKey The application's key used in AadServicePrincipal authentication type. SecretBase
tenant The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
tokenEndpoint The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
url The base URL of the REST service. Type: string (or Expression with resultType string).
userName The user name used in Basic authentication type. Type: string (or Expression with resultType string).

SalesforceLinkedService

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

SalesforceLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

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).
clientSecret The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). SecretBase
connectionProperties Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).

SalesforceServiceCloudLinkedService

Name Description Value
type Type of linked service. 'SalesforceServiceCloud' (required)
typeProperties Salesforce Service Cloud linked service properties. SalesforceServiceCloudLinkedServiceTypeProperties (required)

SalesforceServiceCloudLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
extendedProperties Extended properties appended to the connection string. Type: string (or Expression with resultType string).
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

SalesforceServiceCloudV2LinkedService

Name Description Value
type Type of linked service. 'SalesforceServiceCloudV2' (required)
typeProperties Salesforce Service Cloud V2 linked service properties. SalesforceServiceCloudV2LinkedServiceTypeProperties (required)

SalesforceServiceCloudV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

SalesforceV2LinkedService

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

SalesforceV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP BW server. SecretBase
server Host name of the SAP BW instance. Type: string (or Expression with resultType string).
systemNumber System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP BW server. Type: string (or Expression with resultType string).

SapCloudForCustomerLinkedService

Name Description Value
type Type of linked service. 'SapCloudForCustomer' (required)
typeProperties SAP Cloud for Customer linked service properties. SapCloudForCustomerLinkedServiceTypeProperties (required)

SapCloudForCustomerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).
username The username for Basic authentication. Type: string (or Expression with resultType string).

SapEccLinkedService

Name Description Value
type Type of linked service. 'SapEcc' (required)
typeProperties SAP ECC linked service properties. SapEccLinkedServiceTypeProperties (required)

SapEccLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).
username The username for Basic authentication. Type: string (or Expression with resultType 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'
connectionString SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP HANA server. SecretBase
server Host name of the SAP HANA server. Type: string (or Expression with resultType string).
userName Username to access the SAP HANA server. Type: string (or Expression with resultType string).

SapOdpLinkedService

Name Description Value
type Type of linked service. 'SapOdp' (required)
typeProperties Properties specific to SAP ODP linked service type. SapOdpLinkedServiceTypeProperties (required)

SapOdpLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
subscriberName The subscriber name. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).
x509CertificatePath SNC X509 certificate file path. Type: string (or Expression with resultType string).

SapOpenHubLinkedService

Name Description Value
type Type of linked service. 'SapOpenHub' (required)
typeProperties Properties specific to SAP Business Warehouse Open Hub Destination linked service type. SapOpenHubLinkedServiceTypeProperties (required)

SapOpenHubLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP BW server where the open hub destination is located. SecretBase
server Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).

SapTableLinkedService

Name Description Value
type Type of linked service. 'SapTable' (required)
typeProperties Properties specific to this linked service type. SapTableLinkedServiceTypeProperties (required)

SapTableLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).

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.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNow server. (i.e. {instance}.service-now.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.

ServiceNowV2LinkedService

Name Description Value
type Type of linked service. 'ServiceNowV2' (required)
typeProperties ServiceNowV2 server linked service properties. ServiceNowV2LinkedServiceTypeProperties (required)

ServiceNowV2LinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to use. 'Basic'
'OAuth2' (required)
clientId The client id for OAuth2 authentication.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNowV2 server. (i.e. {instance}.service-now.com)
grantType GrantType for OAuth2 authentication. Default value is password.
password The password corresponding to the user name for Basic and OAuth2 authentication. SecretBase
username The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication.

SftpServerLinkedService

Name Description Value
type Type of linked service. 'Sftp' (required)
typeProperties Properties specific to this linked service type. SftpServerLinkedServiceTypeProperties (required)

SftpServerLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the FTP server. 'Basic'
'MultiFactor'
'SshPublicKey'
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The SFTP server host name. Type: string (or Expression with resultType string).
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).
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.
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).
skipHostKeyValidation If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
userName The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

SharePointOnlineListLinkedService

Name Description Value
type Type of linked service. 'SharePointOnlineList' (required)
typeProperties SharePoint Online List linked service properties. SharePointOnlineListLinkedServiceTypeProperties (required)

SharePointOnlineListLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).
servicePrincipalKey The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase (required)
siteUrl The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).
tenantId The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).

ShopifyLinkedService

Name Description Value
type Type of linked service. 'Shopify' (required)
typeProperties Shopify Service linked service properties. ShopifyLinkedServiceTypeProperties (required)

ShopifyLinkedServiceTypeProperties

Name Description Value
accessToken The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Shopify server. (i.e. mystore.myshopify.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

SmartsheetLinkedService

Name Description Value
type Type of linked service. 'Smartsheet' (required)
typeProperties Smartsheet linked service properties. SmartsheetLinkedServiceTypeProperties (required)

SmartsheetLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Smartsheet source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

SnowflakeLinkedService

Name Description Value
type Type of linked service. 'Snowflake' (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedServiceTypeProperties (required)

SnowflakeLinkedServiceTypeProperties

Name Description Value
connectionString The connection string of snowflake. Type: string, SecureString.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

SnowflakeV2LinkedService

Name Description Value
type Type of linked service. 'SnowflakeV2' (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedV2ServiceTypeProperties (required)

SnowflakeLinkedV2ServiceTypeProperties

Name Description Value
accountIdentifier The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure
authenticationType The type used for authentication. Type: string. 'AADServicePrincipal'
'Basic'
'KeyPair'
clientId The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
clientSecret The Azure key vault secret reference of client secret for AADServicePrincipal authentication. SecretBase
database The name of the Snowflake database.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase
privateKey The Azure key vault secret reference of privateKey for KeyPair auth. SecretBase
privateKeyPassphrase The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. SecretBase
scope The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.
tenantId The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
user The name of the Snowflake user.
warehouse The name of the Snowflake warehouse.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Spark server
httpPath The partial URL corresponding to the Spark server.
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.
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.
username The user name that you use to access Spark Server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

SqlServerLinkedService

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

SqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

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.
clientSecret The client secret associated with your Square application. SecretBase
connectionProperties Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Square instance. (i.e. mystore.mysquare.com)
redirectUri The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
schema Schema name for connection. Type: string (or Expression with resultType string).
server Server name for connection. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

TeamDeskLinkedService

Name Description Value
type Type of linked service. 'TeamDesk' (required)
typeProperties TeamDesk linked service properties. TeamDeskLinkedServiceTypeProperties (required)

TeamDeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the TeamDesk source. SecretBase
authenticationType The authentication type to use. 'Basic'
'Token' (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the TeamDesk source. SecretBase
url The url to connect TeamDesk source. Type: string (or Expression with resultType string).
userName The username of the TeamDesk source. Type: string (or Expression with resultType string).

TeradataLinkedService

Name Description Value
type Type of linked service. 'Teradata' (required)
typeProperties Teradata linked service properties. TeradataLinkedServiceTypeProperties (required)

TeradataLinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. 'Basic'
'Windows'
connectionString Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
server Server name for connection. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

TwilioLinkedService

Name Description Value
type Type of linked service. 'Twilio' (required)
typeProperties Twilio linked service properties. TwilioLinkedServiceTypeProperties (required)

TwilioLinkedServiceTypeProperties

Name Description Value
password The auth token of Twilio service. SecretBase (required)
userName The Account SID of Twilio service. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

WarehouseLinkedService

Name Description Value
type Type of linked service. 'Warehouse' (required)
typeProperties Microsoft Fabric Warehouse linked service properties. WarehouseLinkedServiceTypeProperties (required)

WarehouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string).
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric Warehouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).

WebLinkedService

Name Description Value
type Type of linked service. 'Web' (required)
typeProperties Web linked service properties. WebLinkedServiceTypeProperties (required)

WebLinkedServiceTypeProperties

Name Description Value
url The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).
authenticationType Set the object type Anonymous
Basic
ClientCertificate (required)

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

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)

XeroLinkedService

Name Description Value
type Type of linked service. 'Xero' (required)
typeProperties Xero Service linked service properties. XeroLinkedServiceTypeProperties (required)

XeroLinkedServiceTypeProperties

Name Description Value
connectionProperties Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.
consumerKey The consumer key associated with the Xero application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Xero server. (i.e. api.xero.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

ZendeskLinkedService

Name Description Value
type Type of linked service. 'Zendesk' (required)
typeProperties Zendesk linked service properties. ZendeskLinkedServiceTypeProperties (required)

ZendeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Zendesk source. SecretBase
authenticationType The authentication type to use. 'Basic'
'Token' (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Zendesk source. SecretBase
url The url to connect Zendesk source. Type: string (or Expression with resultType string).
userName The username of the Zendesk source. Type: string (or Expression with resultType string).

ZohoLinkedService

Name Description Value
type Type of linked service. 'Zoho' (required)
typeProperties Zoho server linked service properties. ZohoLinkedServiceTypeProperties (required)

ZohoLinkedServiceTypeProperties

Name Description Value
accessToken The access token for Zoho authentication. SecretBase
connectionProperties Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy the Sports Analytics on Azure Architecture

Deploy to Azure
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

Deploy to Azure
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Create a Data Factory, copy from Salesforce to Blob

Deploy to Azure
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs
Bulk copy using Azure Data Factory

Deploy to Azure
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse.
Create a V2 data factory

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.
Create a V2 data factory (MySQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL.
Create a V2 data factory (PostGre)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL.
Create a V2 data factory (SQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database.
Create a V2 data factory (SQL On-prem)

Deploy to Azure
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage
Create a V2 data factory (Spark)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.

Terraform (AzAPI provider) resource definition

The factories/linkedservices resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/linkedservices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/linkedservices@2018-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      annotations = [ object ]
      connectVia = {
        parameters = {}
        referenceName = "string"
        type = "IntegrationRuntimeReference"
      }
      description = "string"
      parameters = {
        {customized property} = {
          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 = {
    encryptedCredential = "string"
    mwsAuthToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    secretKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AmazonRdsForOracle, use:

  type = "AmazonRdsForOracle"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AmazonRdsForSqlServer, use:

  type = "AmazonRdsForSqlServer"
  typeProperties = {
    alwaysEncryptedSettings = {
      alwaysEncryptedAkvAuthType = "string"
      credential = {
        referenceName = "string"
        type = "CredentialReference"
      }
      servicePrincipalKey = {
        type = "string"
        // For remaining properties, see SecretBase objects
      }
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AmazonRedshift, use:

  type = "AmazonRedshift"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AmazonS3, use:

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

For AmazonS3Compatible, use:

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

For AppFigures, use:

  type = "AppFigures"
  typeProperties = {
    clientKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Asana, use:

  type = "Asana"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For AzureBatch, use:

  type = "AzureBatch"
  typeProperties = {
    accessKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    linkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

For AzureBlobFS, use:

  type = "AzureBlobFS"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    sasToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureBlobStorage, use:

  type = "AzureBlobStorage"
  typeProperties = {
    accountKey = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    authenticationType = "string"
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    sasToken = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureDatabricks, use:

  type = "AzureDatabricks"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    newClusterCustomTags = {}
    newClusterSparkConf = {}
    newClusterSparkEnvVars = {}
  }

For AzureDatabricksDeltaLake, use:

  type = "AzureDatabricksDeltaLake"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
  }

For AzureDataExplorer, use:

  type = "AzureDataExplorer"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureDataLakeAnalytics, use:

  type = "AzureDataLakeAnalytics"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureDataLakeStore, use:

  type = "AzureDataLakeStore"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureFileStorage, use:

  type = "AzureFileStorage"
  typeProperties = {
    accountKey = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    sasToken = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For AzureFunction, use:

  type = "AzureFunction"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    functionKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureKeyVault, use:

  type = "AzureKeyVault"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
  }

For AzureMariaDB, use:

  type = "AzureMariaDB"
  typeProperties = {
    encryptedCredential = "string"
    pwd = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For AzureML, use:

  type = "AzureML"
  typeProperties = {
    apiKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureMLService, use:

  type = "AzureMLService"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureMySql, use:

  type = "AzureMySql"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For AzurePostgreSql, use:

  type = "AzurePostgreSql"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For AzureSearch, use:

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

For AzureSqlDatabase, use:

  type = "AzureSqlDatabase"
  typeProperties = {
    alwaysEncryptedSettings = {
      alwaysEncryptedAkvAuthType = "string"
      credential = {
        referenceName = "string"
        type = "CredentialReference"
      }
      servicePrincipalKey = {
        type = "string"
        // For remaining properties, see SecretBase objects
      }
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureSqlDW, use:

  type = "AzureSqlDW"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureSqlMI, use:

  type = "AzureSqlMI"
  typeProperties = {
    alwaysEncryptedSettings = {
      alwaysEncryptedAkvAuthType = "string"
      credential = {
        referenceName = "string"
        type = "CredentialReference"
      }
      servicePrincipalKey = {
        type = "string"
        // For remaining properties, see SecretBase objects
      }
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For AzureStorage, use:

  type = "AzureStorage"
  typeProperties = {
    accountKey = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    encryptedCredential = "string"
    sasToken = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For AzureSynapseArtifacts, use:

  type = "AzureSynapseArtifacts"
  typeProperties = {}

For AzureTableStorage, use:

  type = "AzureTableStorage"
  typeProperties = {
    accountKey = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    encryptedCredential = "string"
    sasToken = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Cassandra, use:

  type = "Cassandra"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For CommonDataServiceForApps, use:

  type = "CommonDataServiceForApps"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Concur, use:

  type = "Concur"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For CosmosDb, use:

  type = "CosmosDb"
  typeProperties = {
    accountKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    connectionMode = "string"
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For CosmosDbMongoDbApi, use:

  type = "CosmosDbMongoDbApi"
  typeProperties = {}

For Couchbase, use:

  type = "Couchbase"
  typeProperties = {
    credString = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
    encryptedCredential = "string"
  }

For CustomDataSource, use:

  type = "CustomDataSource"

For Dataworld, use:

  type = "Dataworld"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Db2, use:

  type = "Db2"
  typeProperties = {
    authenticationType = "Basic"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Drill, use:

  type = "Drill"
  typeProperties = {
    encryptedCredential = "string"
    pwd = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Dynamics, use:

  type = "Dynamics"
  typeProperties = {
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For DynamicsAX, use:

  type = "DynamicsAX"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For DynamicsCrm, use:

  type = "DynamicsCrm"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Eloqua, use:

  type = "Eloqua"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For FileServer, use:

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

For FtpServer, use:

  type = "FtpServer"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleAdWords, use:

  type = "GoogleAdWords"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    developerToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    privateKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleBigQuery, use:

  type = "GoogleBigQuery"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleBigQueryV2, use:

  type = "GoogleBigQueryV2"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    keyFileContent = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For GoogleCloudStorage, use:

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

For GoogleSheets, use:

  type = "GoogleSheets"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Greenplum, use:

  type = "Greenplum"
  typeProperties = {
    encryptedCredential = "string"
    pwd = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For HBase, use:

  type = "HBase"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Hdfs, use:

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

For HDInsight, use:

  type = "HDInsight"
  typeProperties = {
    encryptedCredential = "string"
    hcatalogLinkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    linkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For HDInsightOnDemand, use:

  type = "HDInsightOnDemand"
  typeProperties = {
    additionalLinkedServiceNames = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
    clusterPassword = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    clusterSshPassword = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    hcatalogLinkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    linkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    scriptActions = [
      {
        name = "string"
        parameters = "string"
        uri = "string"
      }
    ]
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Hive, use:

  type = "Hive"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    serverType = "string"
    thriftTransportProtocol = "string"
  }

For HttpServer, use:

  type = "HttpServer"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Hubspot, use:

  type = "Hubspot"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    refreshToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Impala, use:

  type = "Impala"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Informix, use:

  type = "Informix"
  typeProperties = {
    credential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Jira, use:

  type = "Jira"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For LakeHouse, use:

  type = "LakeHouse"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Magento, use:

  type = "Magento"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For MariaDB, use:

  type = "MariaDB"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Marketo, use:

  type = "Marketo"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For MicrosoftAccess, use:

  type = "MicrosoftAccess"
  typeProperties = {
    credential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For MongoDb, use:

  type = "MongoDb"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For MongoDbAtlas, use:

  type = "MongoDbAtlas"
  typeProperties = {}

For MongoDbV2, use:

  type = "MongoDbV2"
  typeProperties = {}

For MySql, use:

  type = "MySql"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Netezza, use:

  type = "Netezza"
  typeProperties = {
    encryptedCredential = "string"
    pwd = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For OData, use:

  type = "OData"
  typeProperties = {
    aadServicePrincipalCredentialType = "string"
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalEmbeddedCert = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalEmbeddedCertPassword = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Odbc, use:

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

For Office365, use:

  type = "Office365"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Oracle, use:

  type = "Oracle"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For OracleCloudStorage, use:

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

For OracleServiceCloud, use:

  type = "OracleServiceCloud"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Paypal, use:

  type = "Paypal"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Phoenix, use:

  type = "Phoenix"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For PostgreSql, use:

  type = "PostgreSql"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For PostgreSqlV2, use:

  type = "PostgreSqlV2"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Presto, use:

  type = "Presto"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Quickbase, use:

  type = "Quickbase"
  typeProperties = {
    encryptedCredential = "string"
    userToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For QuickBooks, use:

  type = "QuickBooks"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    accessTokenSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    consumerSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Responsys, use:

  type = "Responsys"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For RestService, use:

  type = "RestService"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    credential = {
      referenceName = "string"
      type = "CredentialReference"
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Salesforce, use:

  type = "Salesforce"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    securityToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SalesforceMarketingCloud, use:

  type = "SalesforceMarketingCloud"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For SalesforceServiceCloud, use:

  type = "SalesforceServiceCloud"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    securityToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SalesforceServiceCloudV2, use:

  type = "SalesforceServiceCloudV2"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For SalesforceV2, use:

  type = "SalesforceV2"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For SapBW, use:

  type = "SapBW"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SapCloudForCustomer, use:

  type = "SapCloudForCustomer"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SapEcc, use:

  type = "SapEcc"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SapHana, use:

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

For SapOdp, use:

  type = "SapOdp"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SapOpenHub, use:

  type = "SapOpenHub"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SapTable, use:

  type = "SapTable"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For ServiceNow, use:

  type = "ServiceNow"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For ServiceNowV2, use:

  type = "ServiceNowV2"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Sftp, use:

  type = "Sftp"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    passPhrase = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    privateKeyContent = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For SharePointOnlineList, use:

  type = "SharePointOnlineList"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Shopify, use:

  type = "Shopify"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Smartsheet, use:

  type = "Smartsheet"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Snowflake, use:

  type = "Snowflake"
  typeProperties = {
    encryptedCredential = "string"
    password = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For SnowflakeV2, use:

  type = "SnowflakeV2"
  typeProperties = {
    authenticationType = "string"
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    privateKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    privateKeyPassphrase = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Spark, use:

  type = "Spark"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    serverType = "string"
    thriftTransportProtocol = "string"
  }

For SqlServer, use:

  type = "SqlServer"
  typeProperties = {
    alwaysEncryptedSettings = {
      alwaysEncryptedAkvAuthType = "string"
      credential = {
        referenceName = "string"
        type = "CredentialReference"
      }
      servicePrincipalKey = {
        type = "string"
        // For remaining properties, see SecretBase objects
      }
    }
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Square, use:

  type = "Square"
  typeProperties = {
    clientSecret = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

For Sybase, use:

  type = "Sybase"
  typeProperties = {
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For TeamDesk, use:

  type = "TeamDesk"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Teradata, use:

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

For Twilio, use:

  type = "Twilio"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Vertica, use:

  type = "Vertica"
  typeProperties = {
    encryptedCredential = "string"
    pwd = {
      store = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      type = "string"
    }
  }

For Warehouse, use:

  type = "Warehouse"
  typeProperties = {
    encryptedCredential = "string"
    servicePrincipalCredential = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Web, use:

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

For Xero, use:

  type = "Xero"
  typeProperties = {
    consumerKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
    privateKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Zendesk, use:

  type = "Zendesk"
  typeProperties = {
    apiToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    authenticationType = "string"
    encryptedCredential = "string"
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

For Zoho, use:

  type = "Zoho"
  typeProperties = {
    accessToken = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    encryptedCredential = "string"
  }

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  type = "AzureKeyVaultSecret"
  store = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }

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
  }

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

factories/linkedservices

Name Description Value
type The resource type "Microsoft.DataFactory/factories/linkedservices@2018-06-01"
name The resource name string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/ or control characters

Start with alphanumeric.
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)

LinkedService

Name Description Value
annotations List of tags that can be used for describing the linked service. any[]
connectVia The integration runtime reference. IntegrationRuntimeReference
description Linked service description. string
parameters Parameters for linked service. ParameterDefinitionSpecification
type Set the object type AmazonMWS
AmazonRdsForOracle
AmazonRdsForSqlServer
AmazonRedshift
AmazonS3
AmazonS3Compatible
AppFigures
Asana
AzureBatch
AzureBlobFS
AzureBlobStorage
AzureDatabricks
AzureDatabricksDeltaLake
AzureDataExplorer
AzureDataLakeAnalytics
AzureDataLakeStore
AzureFileStorage
AzureFunction
AzureKeyVault
AzureMariaDB
AzureML
AzureMLService
AzureMySql
AzurePostgreSql
AzureSearch
AzureSqlDatabase
AzureSqlDW
AzureSqlMI
AzureStorage
AzureSynapseArtifacts
AzureTableStorage
Cassandra
CommonDataServiceForApps
Concur
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomDataSource
Dataworld
Db2
Drill
Dynamics
DynamicsAX
DynamicsCrm
Eloqua
FileServer
FtpServer
GoogleAdWords
GoogleBigQuery
GoogleBigQueryV2
GoogleCloudStorage
GoogleSheets
Greenplum
HBase
Hdfs
HDInsight
HDInsightOnDemand
Hive
HttpServer
Hubspot
Impala
Informix
Jira
LakeHouse
Magento
MariaDB
Marketo
MicrosoftAccess
MongoDb
MongoDbAtlas
MongoDbV2
MySql
Netezza
OData
Odbc
Office365
Oracle
OracleCloudStorage
OracleServiceCloud
Paypal
Phoenix
PostgreSql
PostgreSqlV2
Presto
Quickbase
QuickBooks
Responsys
RestService
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SalesforceServiceCloudV2
SalesforceV2
SapBW
SapCloudForCustomer
SapEcc
SapHana
SapOdp
SapOpenHub
SapTable
ServiceNow
ServiceNowV2
Sftp
SharePointOnlineList
Shopify
Smartsheet
Snowflake
SnowflakeV2
Spark
SqlServer
Square
Sybase
TeamDesk
Teradata
Twilio
Vertica
Warehouse
Web
Xero
Zendesk
Zoho (required)

IntegrationRuntimeReference

Name Description Value
parameters Arguments for integration runtime. ParameterValueSpecification
referenceName Reference integration runtime name. string (required)
type Type of integration runtime. "IntegrationRuntimeReference" (required)

ParameterValueSpecification

Name Description Value
{customized property}

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter.
type Parameter type. "Array"
"Bool"
"Float"
"Int"
"Object"
"SecureString"
"String" (required)

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)
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)
mwsAuthToken The Amazon MWS authentication token. SecretBase
secretKey The secret key used to access data. SecretBase
sellerID The Amazon seller ID.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

SecretBase

Name Description Value
type Set the object type AzureKeyVaultSecret
SecureString (required)

AzureKeyVaultSecretReference

Name Description Value
secretName The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
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).
store The Azure Key Vault linked service reference. LinkedServiceReference (required)
type Type of the secret. string (required)

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. "LinkedServiceReference" (required)

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

AmazonRdsForOracleLinkedService

Name Description Value
type Type of linked service. "AmazonRdsForOracle" (required)
typeProperties AmazonRdsForOracle database linked service properties. AmazonRdsForLinkedServiceTypeProperties (required)

AmazonRdsForLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase

AmazonRdsForSqlServerLinkedService

Name Description Value
type Type of linked service. "AmazonRdsForSqlServer" (required)
typeProperties Amazon RDS for SQL Server linked service properties. AmazonRdsForSqlServerLinkedServiceTypeProperties (required)

AmazonRdsForSqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

SqlAlwaysEncryptedProperties

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

CredentialReference

Name Description Value
referenceName Reference credential name. string (required)
type Credential reference type. "CredentialReference" (required)
{customized property}

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Amazon Redshift source. SecretBase
port The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).
server The name of the Amazon Redshift server. Type: string (or Expression with resultType string).
username The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

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).
authenticationType The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Amazon S3 Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
sessionToken The session token for the S3 temporary security credential. SecretBase

AmazonS3CompatibleLinkedService

Name Description Value
type Type of linked service. "AmazonS3Compatible" (required)
typeProperties Amazon S3 Compatible linked service properties. AmazonS3CompatibleLinkedServiceTypeProperties (required)

AmazonS3CompatibleLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
forcePathStyle If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean).
secretAccessKey The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

AppFiguresLinkedService

Name Description Value
type Type of linked service. "AppFigures" (required)
typeProperties AppFigures linked service properties. AppFiguresLinkedServiceTypeProperties (required)

AppFiguresLinkedServiceTypeProperties

Name Description Value
clientKey The client key for the AppFigures source. SecretBase (required)
password The password of the AppFigures source. SecretBase (required)
userName The username of the Appfigures source. Type: string (or Expression with resultType string).

AsanaLinkedService

Name Description Value
type Type of linked service. "Asana" (required)
typeProperties Asana linked service properties. AsanaLinkedServiceTypeProperties (required)

AsanaLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Asana source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

AzureBatchLinkedService

Name Description Value
type Type of linked service. "AzureBatch" (required)
typeProperties Azure Batch linked service properties. AzureBatchLinkedServiceTypeProperties (required)

AzureBatchLinkedServiceTypeProperties

Name Description Value
accessKey The Azure Batch account access key. SecretBase
accountName The Azure Batch account name. Type: string (or Expression with resultType string).
batchUri The Azure Batch URI. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
linkedServiceName The Azure Storage linked service reference. LinkedServiceReference (required)
poolName The Azure Batch pool name. Type: string (or Expression with resultType string).

AzureBlobFSLinkedService

Name Description Value
type Type of linked service. "AzureBlobFS" (required)
typeProperties Azure Data Lake Storage Gen2 linked service properties. AzureBlobFSLinkedServiceTypeProperties (required)

AzureBlobFSLinkedServiceTypeProperties

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

AzureBlobStorageLinkedService

Name Description Value
type Type of linked service. "AzureBlobStorage" (required)
typeProperties Azure Blob Storage linked service properties. AzureBlobStorageLinkedServiceTypeProperties (required)

AzureBlobStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
accountKind Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).
authenticationType The type used for authentication. Type: string. "AccountKey"
"Anonymous"
"Msi"
"SasUri"
"ServicePrincipal"
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
containerUri Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
serviceEndpoint Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
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).

AzureDatabricksLinkedService

Name Description Value
type Type of linked service. "AzureDatabricks" (required)
typeProperties Azure Databricks linked service properties. AzureDatabricksLinkedServiceTypeProperties (required)

AzureDatabricksLinkedServiceTypeProperties

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

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property}

AzureDatabricksLinkedServiceTypePropertiesNewCluster...

Name Description Value
{customized property}

AzureDatabricksDeltaLakeLinkedService

Name Description Value
type Type of linked service. "AzureDatabricksDeltaLake" (required)
typeProperties Azure Databricks Delta Lake linked service properties. AzureDatabricksDetltaLakeLinkedServiceTypeProperties (required)

AzureDatabricksDetltaLakeLinkedServiceTypeProperties

Name Description Value
accessToken Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. SecretBase
clusterId The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
domain {REGION}.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
workspaceResourceId Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

AzureDataExplorerLinkedService

Name Description Value
type Type of linked service. "AzureDataExplorer" (required)
typeProperties Azure Data Explorer (Kusto) linked service properties. AzureDataExplorerLinkedServiceTypeProperties (required)

AzureDataExplorerLinkedServiceTypeProperties

Name Description Value
credential The credential reference containing authentication information. CredentialReference
database Database name for connection. Type: string (or Expression with resultType string).
endpoint The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://{clusterName}.{regionName}.kusto.windows.net. Type: string (or Expression with resultType string)
servicePrincipalId The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against Kusto. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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).
dataLakeAnalyticsUri Azure Data Lake Analytics URI Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).
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).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
dataLakeStoreUri Data Lake Store service URI. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
resourceGroupName Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).
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).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

AzureFileStorageLinkedService

Name Description Value
type Type of linked service. "AzureFileStorage" (required)
typeProperties Azure File Storage linked service properties. AzureFileStorageLinkedServiceTypeProperties (required)

AzureFileStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileShare The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
host Host name of the server. Type: string (or Expression with resultType string).
password Password to logon the server. SecretBase
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
snapshot The azure file share snapshot version. Type: string (or Expression with resultType string).
userId User ID to logon the server. Type: string (or Expression with resultType string).

AzureFunctionLinkedService

Name Description Value
type Type of linked service. "AzureFunction" (required)
typeProperties Azure Function linked service properties. AzureFunctionLinkedServiceTypeProperties (required)

AzureFunctionLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
functionAppUrl The endpoint of the Azure Function App. URL will be in the format https://{accountName}.azurewebsites.net. Type: string (or Expression with resultType string).
functionKey Function or Host key for Azure Function App. SecretBase
resourceId Allowed token audiences for azure function. Type: string (or Expression with resultType string).

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).
credential The credential reference containing authentication information. CredentialReference

AzureMariaDBLinkedService

Name Description Value
type Type of linked service. "AzureMariaDB" (required)
typeProperties Azure Database for MariaDB linked service properties. AzureMariaDBLinkedServiceTypeProperties (required)

AzureMariaDBLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureMLLinkedService

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

AzureMLLinkedServiceTypeProperties

Name Description Value
apiKey The API key for accessing the Azure ML model endpoint. SecretBase (required)
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlEndpoint The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
updateResourceEndpoint The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

AzureMLServiceLinkedService

Name Description Value
type Type of linked service. "AzureMLService" (required)
typeProperties Azure ML Service linked service properties. AzureMLServiceLinkedServiceTypeProperties (required)

AzureMLServiceLinkedServiceTypeProperties

Name Description Value
authentication Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
mlWorkspaceName Azure ML Service workspace name. Type: string (or Expression with resultType string).
resourceGroupName Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. SecretBase
subscriptionId Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzurePostgreSqlLinkedService

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

AzurePostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

AzureSearchLinkedService

Name Description Value
type Type of linked service. "AzureSearch" (required)
typeProperties Windows Azure Search Service linked service properties. AzureSearchLinkedServiceTypeProperties (required)

AzureSearchLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
key Admin Key for Azure Search service SecretBase
url URL for Azure Search service. Type: string (or Expression with resultType string).

AzureSqlDatabaseLinkedService

Name Description Value
type Type of linked service. "AzureSqlDatabase" (required)
typeProperties Azure SQL Database linked service properties. AzureSqlDatabaseLinkedServiceTypeProperties (required)

AzureSqlDatabaseLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
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).

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
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
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).

AzureSqlMILinkedService

Name Description Value
type Type of linked service. "AzureSqlMI" (required)
typeProperties Azure SQL Managed Instance linked service properties. AzureSqlMILinkedServiceTypeProperties (required)

AzureSqlMILinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
servicePrincipalId The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).
servicePrincipalKey The key of the service principal used to authenticate against Azure SQL Managed Instance. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

AzureStorageLinkedService

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

AzureStorageLinkedServiceTypeProperties

Name Description Value
accountKey The Azure key vault secret reference of accountKey in connection string. AzureKeyVaultSecretReference
connectionString The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
sasToken The Azure key vault secret reference of sasToken in sas uri. AzureKeyVaultSecretReference
sasUri SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

AzureSynapseArtifactsLinkedService

Name Description Value
type Type of linked service. "AzureSynapseArtifacts" (required)
typeProperties Azure Synapse Analytics (Artifacts) linked service properties. AzureSynapseArtifactsLinkedServiceTypeProperties (required)

AzureSynapseArtifactsLinkedServiceTypeProperties

Name Description Value
authentication Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string).
endpoint https://{workspacename}.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string).
workspaceResourceId The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string).

AzureTableStorageLinkedService

Name Description Value
type Type of linked service. "AzureTableStorage" (required)
typeProperties Azure Table Storage linked service properties. AzureStorageLinkedServiceTypeProperties (required)

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name for connection. Type: string (or Expression with resultType string).
password Password for authentication. SecretBase
port The port for the connection. Type: integer (or Expression with resultType integer).
username Username for authentication. Type: string (or Expression with resultType string).

CommonDataServiceForAppsLinkedService

Name Description Value
type Type of linked service. "CommonDataServiceForApps" (required)
typeProperties Common Data Service for Apps linked service properties. CommonDataServiceForAppsLinkedServiceTypeProperties (required)

CommonDataServiceForAppsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
deploymentType The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
organizationName The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).
password Password to access the Common Data Service for Apps instance. SecretBase
port The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
serviceUri The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
username User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).

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.
connectionProperties Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password corresponding to the user name that you provided in the username field. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name that you use to access Concur Service.

CosmosDbLinkedService

Name Description Value
type Type of linked service. "CosmosDb" (required)
typeProperties CosmosDB linked service properties. CosmosDbLinkedServiceTypeProperties (required)

CosmosDbLinkedServiceTypeProperties

Name Description Value
accountEndpoint The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)
accountKey The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. SecretBase
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
connectionMode The connection mode used to access CosmosDB account. Type: string. "Direct"
"Gateway"
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential The credential reference containing authentication information. CredentialReference
database The name of the database. Type: string (or Expression with resultType string)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

CosmosDbMongoDbApiLinkedService

Name Description Value
type Type of linked service. "CosmosDbMongoDbApi" (required)
typeProperties CosmosDB (MongoDB API) linked service properties. CosmosDbMongoDbApiLinkedServiceTypeProperties (required)

CosmosDbMongoDbApiLinkedServiceTypeProperties

Name Description Value
connectionString The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).
isServerVersionAbove32 Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

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.
credString The Azure key vault secret reference of credString in connection string. AzureKeyVaultSecretReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

CustomDataSourceLinkedService

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

DataworldLinkedService

Name Description Value
type Type of linked service. "Dataworld" (required)
typeProperties Dataworld linked service properties. DataworldLinkedServiceTypeProperties (required)

DataworldLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Dataworld source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

Db2LinkedService

Name Description Value
type Type of linked service. "Db2" (required)
typeProperties DB2 linked service properties. Db2LinkedServiceTypeProperties (required)

Db2LinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. "Basic"
certificateCommonName Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
connectionString The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
database Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. string
packageCollection Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
password Password for authentication. SecretBase
server Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
username Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

DynamicsLinkedService

Name Description Value
type Type of linked service. "Dynamics" (required)
typeProperties Dynamics linked service properties. DynamicsLinkedServiceTypeProperties (required)

DynamicsLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
credential The credential reference containing authentication information. CredentialReference
deploymentType The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
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).
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.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
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).
username User name to access the Dynamics instance. Type: string (or Expression with resultType string).

DynamicsAXLinkedService

Name Description Value
type Type of linked service. "DynamicsAX" (required)
typeProperties Dynamics AX linked service properties. DynamicsAXLinkedServiceTypeProperties (required)

DynamicsAXLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string). SecretBase (required)
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).
url The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.

DynamicsCrmLinkedService

Name Description Value
type Type of linked service. "DynamicsCrm" (required)
typeProperties Dynamics CRM linked service properties. DynamicsCrmLinkedServiceTypeProperties (required)

DynamicsCrmLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
deploymentType The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hostName The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
organizationName The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).
password Password to access the Dynamics CRM instance. SecretBase
port The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
serviceUri The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
username User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).

EloquaLinkedService

Name Description Value
type Type of linked service. "Eloqua" (required)
typeProperties Eloqua server linked service properties. EloquaLinkedServiceTypeProperties (required)

EloquaLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Eloqua server. (i.e. eloqua.example.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)

FileServerLinkedService

Name Description Value
type Type of linked service. "FileServer" (required)
typeProperties File system linked service properties. FileServerLinkedServiceTypeProperties (required)

FileServerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the server. Type: string (or Expression with resultType string).
password Password to logon the server. SecretBase
userId User ID to logon the server. Type: string (or Expression with resultType string).

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).
enableSsl If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host Host name of the FTP server. Type: string (or Expression with resultType string).
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.
userName Username to logon the FTP server. Type: string (or Expression with resultType string).

GoogleAdWordsLinkedService

Name Description Value
type Type of linked service. "GoogleAdWords" (required)
typeProperties Google AdWords service linked service properties. GoogleAdWordsLinkedServiceTypeProperties (required)

GoogleAdWordsLinkedServiceTypeProperties

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

GoogleBigQueryLinkedService

Name Description Value
type Type of linked service. "GoogleBigQuery" (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryLinkedServiceTypeProperties (required)

GoogleBigQueryLinkedServiceTypeProperties

Name Description Value
additionalProjects A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string).
authenticationType The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. "ServiceAuthentication"
"UserAuthentication" (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
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. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFilePath The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
project The default BigQuery project to query against. Type: string (or Expression with resultType string).
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase
requestGoogleDriveScope Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string).
trustedCertPath The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean).

GoogleBigQueryV2LinkedService

Name Description Value
type Type of linked service. "GoogleBigQueryV2" (required)
typeProperties Google BigQuery service linked service properties. GoogleBigQueryV2LinkedServiceTypeProperties (required)

GoogleBigQueryV2LinkedServiceTypeProperties

Name Description Value
authenticationType The OAuth 2.0 authentication mechanism used for authentication. "ServiceAuthentication"
"UserAuthentication" (required)
clientId The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
clientSecret The client secret of the google application used to acquire the refresh token. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
keyFileContent The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). SecretBase
projectId The default BigQuery project id to query against. Type: string (or Expression with resultType string).
refreshToken The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. SecretBase

GoogleCloudStorageLinkedService

Name Description Value
type Type of linked service. "GoogleCloudStorage" (required)
typeProperties Google Cloud Storage linked service properties. GoogleCloudStorageLinkedServiceTypeProperties (required)

GoogleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

GoogleSheetsLinkedService

Name Description Value
type Type of linked service. "GoogleSheets" (required)
typeProperties GoogleSheets linked service properties. GoogleSheetsLinkedServiceTypeProperties (required)

GoogleSheetsLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the GoogleSheets source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

GreenplumLinkedService

Name Description Value
type Type of linked service. "Greenplum" (required)
typeProperties Greenplum Database linked service properties. GreenplumLinkedServiceTypeProperties (required)

GreenplumLinkedServiceTypeProperties

Name Description Value
connectionString An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

HBaseLinkedService

Name Description Value
type Type of linked service. "HBase" (required)
typeProperties HBase server linked service properties. HBaseLinkedServiceTypeProperties (required)

HBaseLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the HBase server. (i.e. 192.168.222.160)
httpPath The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)
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.
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.
username The user name used to connect to the HBase instance.

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Windows authentication. SecretBase
url The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).
userName User name for Windows authentication. Type: string (or Expression with resultType string).

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
fileSystem Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).
hcatalogLinkedServiceName A reference to the Azure SQL linked service that points to the HCatalog database. LinkedServiceReference
isEspEnabled Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.
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).

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).
clusterPassword The password to access the cluster. SecretBase
clusterResourceGroup The resource group where the cluster belongs. Type: string (or Expression with resultType string).
clusterSize Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).
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).
clusterType The cluster type. Type: string (or Expression with resultType string).
clusterUserName The username to access the cluster. Type: string (or Expression with resultType string).
coreConfiguration Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
credential The credential reference containing authentication information. CredentialReference
dataNodeSize Specifies the size of the data node for the HDInsight cluster.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
hBaseConfiguration Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
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.
headNodeSize Specifies the size of the head node for the HDInsight cluster.
hiveConfiguration Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
hostSubscriptionId The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
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.
oozieConfiguration Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
scriptActions Custom script actions to run on HDI ondemand cluster once it's up. Please refer to /azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. ScriptAction[]
servicePrincipalId The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
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).
stormConfiguration Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
subnetName The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).
tenant The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
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).
version Version of the HDInsight cluster.  Type: string (or Expression with resultType string).
virtualNetworkId The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
yarnConfiguration Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
zookeeperNodeSize Specifies the size of the Zoo Keeper node for the HDInsight cluster.

ScriptAction

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

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).
httpPath The partial URL corresponding to the Hive server.
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.
serverType The type of Hive server. "HiveServer1"
"HiveServer2"
"HiveThriftServer"
serviceDiscoveryMode true to indicate using the ZooKeeper service, false not.
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.
useNativeQuery Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
username The user name that you use to access Hive Server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
zooKeeperNameSpace The namespace on ZooKeeper under which Hive Server 2 nodes are added.

HttpLinkedService

Name Description Value
type Type of linked service. "HttpServer" (required)
typeProperties Properties specific to this linked service type. HttpLinkedServiceTypeProperties (required)

HttpLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the HTTP server. "Anonymous"
"Basic"
"ClientCertificate"
"Digest"
"Windows"
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
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).
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).
enableServerCertificateValidation If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. SecretBase
url The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).
userName User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

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.
clientSecret The client secret associated with your Hubspot application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
refreshToken The refresh token obtained when initially authenticating your OAuth integration. SecretBase
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Impala server. (i.e. 192.168.222.160)
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.
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.
username The user name used to access the Impala server. The default value is anonymous when using SASLUsername.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

InformixLinkedService

Name Description Value
type Type of linked service. "Informix" (required)
typeProperties Informix linked service properties. InformixLinkedServiceTypeProperties (required)

InformixLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

JiraLinkedService

Name Description Value
type Type of linked service. "Jira" (required)
typeProperties Jira Service linked service properties. JiraLinkedServiceTypeProperties (required)

JiraLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Jira service. (e.g. jira.example.com)
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.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name that you use to access Jira Service.

LakeHouseLinkedService

Name Description Value
type Type of linked service. "LakeHouse" (required)
typeProperties Microsoft Fabric LakeHouse linked service properties. LakeHouseLinkedServiceTypeProperties (required)

LakeHouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric LakeHouse artifact. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric LakeHouse. Type: string (or Expression with resultType string).
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric LakeHouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).

MagentoLinkedService

Name Description Value
type Type of linked service. "Magento" (required)
typeProperties Magento server linked service properties. MagentoLinkedServiceTypeProperties (required)

MagentoLinkedServiceTypeProperties

Name Description Value
accessToken The access token from Magento. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Magento instance. (i.e. 192.168.222.110/magento3)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
database Database name for connection. Type: string.
driverVersion The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer.
server Server name for connection. Type: string.
username Username for authentication. Type: string.

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.
clientSecret The client secret of your Marketo service. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

MicrosoftAccessLinkedService

Name Description Value
type Type of linked service. "MicrosoftAccess" (required)
typeProperties Microsoft Access linked service properties. MicrosoftAccessLinkedServiceTypeProperties (required)

MicrosoftAccessLinkedServiceTypeProperties

Name Description Value
authenticationType Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

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).
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).
databaseName The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
port The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
server The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

MongoDbAtlasLinkedService

Name Description Value
type Type of linked service. "MongoDbAtlas" (required)
typeProperties MongoDB Atlas linked service properties. MongoDbAtlasLinkedServiceTypeProperties (required)

MongoDbAtlasLinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).
driverVersion The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string).

MongoDbV2LinkedService

Name Description Value
type Type of linked service. "MongoDbV2" (required)
typeProperties MongoDB linked service properties. MongoDbV2LinkedServiceTypeProperties (required)

MongoDbV2LinkedServiceTypeProperties

Name Description Value
connectionString The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

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. Type: string, SecureString or AzureKeyVaultSecretReference.
database Database name for connection. Type: string.
driverVersion The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference
port The port for the connection. Type: integer.
server Server name for connection. Type: string.
sslMode SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.
username Username for authentication. Type: string.
useSystemTrustStore Use system trust store for connection. Type: integer. 0: enable, 1: disable.

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

ODataLinkedService

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

ODataLinkedServiceTypeProperties

Name Description Value
aadResourceId Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
aadServicePrincipalCredentialType Specify the credential type (key or cert) is used for service principal. "ServicePrincipalCert"
"ServicePrincipalKey"
authenticationType Type of authentication used to connect to the OData service. "AadServicePrincipal"
"Anonymous"
"Basic"
"ManagedServiceIdentity"
"Windows"
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password of the OData service. SecretBase
servicePrincipalEmbeddedCert Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
servicePrincipalEmbeddedCertPassword Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). SecretBase
servicePrincipalId Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase
tenant Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
url The URL of the OData service endpoint. Type: string (or Expression with resultType string).
userName User name of the OData service. Type: string (or Expression with resultType string).

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).
connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
credential The access credential portion of the connection string specified in driver-specific property-value format. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for Basic authentication. SecretBase
userName User name for Basic authentication. Type: string (or Expression with resultType string).

Office365LinkedService

Name Description Value
type Type of linked service. "Office365" (required)
typeProperties Office365 linked service properties. Office365LinkedServiceTypeProperties (required)

Office365LinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
office365TenantId Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).
servicePrincipalId Specify the application's client ID. Type: string (or Expression with resultType string).
servicePrincipalKey Specify the application's key. SecretBase (required)
servicePrincipalTenantId Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

OracleCloudStorageLinkedService

Name Description Value
type Type of linked service. "OracleCloudStorage" (required)
typeProperties Oracle Cloud Storage linked service properties. OracleCloudStorageLinkedServiceTypeProperties (required)

OracleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
secretAccessKey The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. SecretBase
serviceUrl This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

OracleServiceCloudLinkedService

Name Description Value
type Type of linked service. "OracleServiceCloud" (required)
typeProperties Oracle Service Cloud linked service properties. OracleServiceCloudLinkedServiceTypeProperties (required)

OracleServiceCloudLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Oracle Service Cloud instance.
password The password corresponding to the user name that you provided in the username key. SecretBase (required)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).
username The user name that you use to access Oracle Service Cloud server.

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.
clientSecret The client secret associated with your PayPal application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)
httpPath The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.
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.
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.
username The user name used to connect to the Phoenix server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

PostgreSqlLinkedService

Name Description Value
type Type of linked service. "PostgreSql" (required)
typeProperties PostgreSQL linked service properties. PostgreSqlLinkedServiceTypeProperties (required)

PostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

PostgreSqlV2LinkedService

Name Description Value
type Type of linked service. "PostgreSqlV2" (required)
typeProperties PostgreSQLV2 linked service properties. PostgreSqlV2LinkedServiceTypeProperties (required)

PostgreSqlV2LinkedServiceTypeProperties

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

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
authenticationType The authentication mechanism used to connect to the Presto server. "Anonymous"
"LDAP" (required)
catalog The catalog context for all request against the server.
enableSsl Specifies whether the connections to the server are encrypted using SSL. The default value is false.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The IP address or host name of the Presto server. (i.e. 192.168.222.160)
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.
serverVersion The version of the Presto server. (i.e. 0.148-t)
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.
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.
username The user name used to connect to the Presto server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

QuickbaseLinkedService

Name Description Value
type Type of linked service. "Quickbase" (required)
typeProperties Quickbase linked service properties. QuickbaseLinkedServiceTypeProperties (required)

QuickbaseLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
url The url to connect Quickbase source. Type: string (or Expression with resultType string).
userToken The user token for the Quickbase source. SecretBase (required)

QuickBooksLinkedService

Name Description Value
type Type of linked service. "QuickBooks" (required)
typeProperties QuickBooks server linked service properties. QuickBooksLinkedServiceTypeProperties (required)

QuickBooksLinkedServiceTypeProperties

Name Description Value
accessToken The access token for OAuth 1.0 authentication. SecretBase
accessTokenSecret The access token secret for OAuth 1.0 authentication. SecretBase
companyId The company ID of the QuickBooks company to authorize.
connectionProperties Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.
consumerKey The consumer key for OAuth 1.0 authentication.
consumerSecret The consumer secret for OAuth 1.0 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

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).
clientSecret The client secret associated with the Responsys application. Type: string (or Expression with resultType string). SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Responsys server.
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).

RestServiceLinkedService

Name Description Value
type Type of linked service. "RestService" (required)
typeProperties Rest Service linked service properties. RestServiceLinkedServiceTypeProperties (required)

RestServiceLinkedServiceTypeProperties

Name Description Value
aadResourceId The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
authenticationType Type of authentication used to connect to the REST service. "AadServicePrincipal"
"Anonymous"
"Basic"
"ManagedServiceIdentity"
"OAuth2ClientCredential" (required)
authHeaders The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
azureCloudType Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
clientId The client ID associated with your application. Type: string (or Expression with resultType string).
clientSecret The client secret associated with your application. SecretBase
credential The credential reference containing authentication information. CredentialReference
enableServerCertificateValidation Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password used in Basic authentication type. SecretBase
resource The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
scope The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
servicePrincipalId The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
servicePrincipalKey The application's key used in AadServicePrincipal authentication type. SecretBase
tenant The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
tokenEndpoint The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
url The base URL of the REST service. Type: string (or Expression with resultType string).
userName The user name used in Basic authentication type. Type: string (or Expression with resultType string).

SalesforceLinkedService

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

SalesforceLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

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).
clientSecret The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). SecretBase
connectionProperties Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
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).
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).

SalesforceServiceCloudLinkedService

Name Description Value
type Type of linked service. "SalesforceServiceCloud" (required)
typeProperties Salesforce Service Cloud linked service properties. SalesforceServiceCloudLinkedServiceTypeProperties (required)

SalesforceServiceCloudLinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
extendedProperties Extended properties appended to the connection string. Type: string (or Expression with resultType string).
password The password for Basic authentication of the Salesforce instance. SecretBase
securityToken The security token is optional to remotely access Salesforce instance. SecretBase
username The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

SalesforceServiceCloudV2LinkedService

Name Description Value
type Type of linked service. "SalesforceServiceCloudV2" (required)
typeProperties Salesforce Service Cloud V2 linked service properties. SalesforceServiceCloudV2LinkedServiceTypeProperties (required)

SalesforceServiceCloudV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

SalesforceV2LinkedService

Name Description Value
type Type of linked service. "SalesforceV2" (required)
typeProperties Salesforce V2 linked service properties. SalesforceV2LinkedServiceTypeProperties (required)

SalesforceV2LinkedServiceTypeProperties

Name Description Value
apiVersion The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
authenticationType The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
clientId The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
clientSecret The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
environmentUrl The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP BW server. SecretBase
server Host name of the SAP BW instance. Type: string (or Expression with resultType string).
systemNumber System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP BW server. Type: string (or Expression with resultType string).

SapCloudForCustomerLinkedService

Name Description Value
type Type of linked service. "SapCloudForCustomer" (required)
typeProperties SAP Cloud for Customer linked service properties. SapCloudForCustomerLinkedServiceTypeProperties (required)

SapCloudForCustomerLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).
username The username for Basic authentication. Type: string (or Expression with resultType string).

SapEccLinkedService

Name Description Value
type Type of linked service. "SapEcc" (required)
typeProperties SAP ECC linked service properties. SapEccLinkedServiceTypeProperties (required)

SapEccLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. string
password The password for Basic authentication. SecretBase
url The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).
username The username for Basic authentication. Type: string (or Expression with resultType 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"
connectionString SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password to access the SAP HANA server. SecretBase
server Host name of the SAP HANA server. Type: string (or Expression with resultType string).
userName Username to access the SAP HANA server. Type: string (or Expression with resultType string).

SapOdpLinkedService

Name Description Value
type Type of linked service. "SapOdp" (required)
typeProperties Properties specific to SAP ODP linked service type. SapOdpLinkedServiceTypeProperties (required)

SapOdpLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
subscriberName The subscriber name. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).
x509CertificatePath SNC X509 certificate file path. Type: string (or Expression with resultType string).

SapOpenHubLinkedService

Name Description Value
type Type of linked service. "SapOpenHub" (required)
typeProperties Properties specific to SAP Business Warehouse Open Hub Destination linked service type. SapOpenHubLinkedServiceTypeProperties (required)

SapOpenHubLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP BW server where the open hub destination is located. SecretBase
server Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).

SapTableLinkedService

Name Description Value
type Type of linked service. "SapTable" (required)
typeProperties Properties specific to this linked service type. SapTableLinkedServiceTypeProperties (required)

SapTableLinkedServiceTypeProperties

Name Description Value
clientId Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
language Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
logonGroup The Logon Group for the SAP System. Type: string (or Expression with resultType string).
messageServer The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
messageServerService The service name or port number of the Message Server. Type: string (or Expression with resultType string).
password Password to access the SAP server where the table is located. SecretBase
server Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
sncLibraryPath External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncMode SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
sncMyName Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncPartnerName Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
sncQop SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
systemId SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
systemNumber System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
userName Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).

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.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNow server. (i.e. {instance}.service-now.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
username The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.

ServiceNowV2LinkedService

Name Description Value
type Type of linked service. "ServiceNowV2" (required)
typeProperties ServiceNowV2 server linked service properties. ServiceNowV2LinkedServiceTypeProperties (required)

ServiceNowV2LinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to use. "Basic"
"OAuth2" (required)
clientId The client id for OAuth2 authentication.
clientSecret The client secret for OAuth2 authentication. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the ServiceNowV2 server. (i.e. {instance}.service-now.com)
grantType GrantType for OAuth2 authentication. Default value is password.
password The password corresponding to the user name for Basic and OAuth2 authentication. SecretBase
username The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication.

SftpServerLinkedService

Name Description Value
type Type of linked service. "Sftp" (required)
typeProperties Properties specific to this linked service type. SftpServerLinkedServiceTypeProperties (required)

SftpServerLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to be used to connect to the FTP server. "Basic"
"MultiFactor"
"SshPublicKey"
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The SFTP server host name. Type: string (or Expression with resultType string).
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).
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.
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).
skipHostKeyValidation If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
userName The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

SharePointOnlineListLinkedService

Name Description Value
type Type of linked service. "SharePointOnlineList" (required)
typeProperties SharePoint Online List linked service properties. SharePointOnlineListLinkedServiceTypeProperties (required)

SharePointOnlineListLinkedServiceTypeProperties

Name Description Value
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
servicePrincipalId The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).
servicePrincipalKey The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). SecretBase (required)
siteUrl The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).
tenantId The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).

ShopifyLinkedService

Name Description Value
type Type of linked service. "Shopify" (required)
typeProperties Shopify Service linked service properties. ShopifyLinkedServiceTypeProperties (required)

ShopifyLinkedServiceTypeProperties

Name Description Value
accessToken The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Shopify server. (i.e. mystore.myshopify.com)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

SmartsheetLinkedService

Name Description Value
type Type of linked service. "Smartsheet" (required)
typeProperties Smartsheet linked service properties. SmartsheetLinkedServiceTypeProperties (required)

SmartsheetLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Smartsheet source. SecretBase (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string

SnowflakeLinkedService

Name Description Value
type Type of linked service. "Snowflake" (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedServiceTypeProperties (required)

SnowflakeLinkedServiceTypeProperties

Name Description Value
connectionString The connection string of snowflake. Type: string, SecureString.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

SnowflakeV2LinkedService

Name Description Value
type Type of linked service. "SnowflakeV2" (required)
typeProperties Snowflake linked service properties. SnowflakeLinkedV2ServiceTypeProperties (required)

SnowflakeLinkedV2ServiceTypeProperties

Name Description Value
accountIdentifier The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure
authenticationType The type used for authentication. Type: string. "AADServicePrincipal"
"Basic"
"KeyPair"
clientId The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
clientSecret The Azure key vault secret reference of client secret for AADServicePrincipal authentication. SecretBase
database The name of the Snowflake database.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The Azure key vault secret reference of password in connection string. SecretBase
privateKey The Azure key vault secret reference of privateKey for KeyPair auth. SecretBase
privateKeyPassphrase The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. SecretBase
scope The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.
tenantId The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
user The name of the Snowflake user.
warehouse The name of the Snowflake warehouse.

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.
allowSelfSignedServerCert Specifies whether to allow self-signed certificates from the server. The default value is false.
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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host IP address or host name of the Spark server
httpPath The partial URL corresponding to the Spark server.
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.
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.
username The user name that you use to access Spark Server.
useSystemTrustStore Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

SqlServerLinkedService

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

SqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The on-premises Windows authentication password. SecretBase
userName The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

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.
clientSecret The client secret associated with your Square application. SecretBase
connectionProperties Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The URL of the Square instance. (i.e. mystore.mysquare.com)
redirectUri The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

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).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
schema Schema name for connection. Type: string (or Expression with resultType string).
server Server name for connection. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

TeamDeskLinkedService

Name Description Value
type Type of linked service. "TeamDesk" (required)
typeProperties TeamDesk linked service properties. TeamDeskLinkedServiceTypeProperties (required)

TeamDeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the TeamDesk source. SecretBase
authenticationType The authentication type to use. "Basic"
"Token" (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the TeamDesk source. SecretBase
url The url to connect TeamDesk source. Type: string (or Expression with resultType string).
userName The username of the TeamDesk source. Type: string (or Expression with resultType string).

TeradataLinkedService

Name Description Value
type Type of linked service. "Teradata" (required)
typeProperties Teradata linked service properties. TeradataLinkedServiceTypeProperties (required)

TeradataLinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. "Basic"
"Windows"
connectionString Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password Password for authentication. SecretBase
server Server name for connection. Type: string (or Expression with resultType string).
username Username for authentication. Type: string (or Expression with resultType string).

TwilioLinkedService

Name Description Value
type Type of linked service. "Twilio" (required)
typeProperties Twilio linked service properties. TwilioLinkedServiceTypeProperties (required)

TwilioLinkedServiceTypeProperties

Name Description Value
password The auth token of Twilio service. SecretBase (required)
userName The Account SID of Twilio service. Type: string (or Expression with resultType string).

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.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
pwd The Azure key vault secret reference of password in connection string. AzureKeyVaultSecretReference

WarehouseLinkedService

Name Description Value
type Type of linked service. "Warehouse" (required)
typeProperties Microsoft Fabric Warehouse linked service properties. WarehouseLinkedServiceTypeProperties (required)

WarehouseLinkedServiceTypeProperties

Name Description Value
artifactId The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string).
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string).
servicePrincipalCredential The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. SecretBase
servicePrincipalCredentialType The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalId The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
servicePrincipalKey The Key of the application used to authenticate against Microsoft Fabric Warehouse. SecretBase
tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
workspaceId The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).

WebLinkedService

Name Description Value
type Type of linked service. "Web" (required)
typeProperties Web linked service properties. WebLinkedServiceTypeProperties (required)

WebLinkedServiceTypeProperties

Name Description Value
url The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).
authenticationType Set the object type Anonymous
Basic
ClientCertificate (required)

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

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)

XeroLinkedService

Name Description Value
type Type of linked service. "Xero" (required)
typeProperties Xero Service linked service properties. XeroLinkedServiceTypeProperties (required)

XeroLinkedServiceTypeProperties

Name Description Value
connectionProperties Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.
consumerKey The consumer key associated with the Xero application. SecretBase
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
host The endpoint of the Xero server. (i.e. api.xero.com)
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.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

ZendeskLinkedService

Name Description Value
type Type of linked service. "Zendesk" (required)
typeProperties Zendesk linked service properties. ZendeskLinkedServiceTypeProperties (required)

ZendeskLinkedServiceTypeProperties

Name Description Value
apiToken The api token for the Zendesk source. SecretBase
authenticationType The authentication type to use. "Basic"
"Token" (required)
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
password The password of the Zendesk source. SecretBase
url The url to connect Zendesk source. Type: string (or Expression with resultType string).
userName The username of the Zendesk source. Type: string (or Expression with resultType string).

ZohoLinkedService

Name Description Value
type Type of linked service. "Zoho" (required)
typeProperties Zoho server linked service properties. ZohoLinkedServiceTypeProperties (required)

ZohoLinkedServiceTypeProperties

Name Description Value
accessToken The access token for Zoho authentication. SecretBase
connectionProperties Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. string
endpoint The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
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.
usePeerVerification Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.