Microsoft.DataFactory factories/linkedservices

The factories/linkedservices resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.DataFactory/factories/linkedservices@2018-06-01' = {
  name: 'string'
  properties: {
    annotations: [ any ]
    connectVia: {
      parameters: {}
      referenceName: 'string'
      type: 'IntegrationRuntimeReference'
    }
    description: 'string'
    parameters: {}
    type: 'string'
    // For remaining properties, see LinkedService objects
  }
}

LinkedService objects

Set the type property to specify the type of object.

For AmazonMWS, use:

  type: 'AmazonMWS'
  typeProperties: {
    accessKeyId: any()
    encryptedCredential: any()
    endpoint: any()
    marketplaceID: any()
    mwsAuthToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    secretKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sellerID: any()
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For AmazonRedshift, use:

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

For AmazonS3, use:

  type: 'AmazonS3'
  typeProperties: {
    accessKeyId: any()
    authenticationType: any()
    encryptedCredential: any()
    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: any()
    forcePathStyle: any()
    secretAccessKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    serviceUrl: any()
  }

For AzureBatch, use:

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

For AzureBlobFS, use:

  type: 'AzureBlobFS'
  typeProperties: {
    accountKey: any()
    azureCloudType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    encryptedCredential: 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: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    accountKind: 'string'
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    encryptedCredential: 'string'
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
    serviceEndpoint: 'string'
    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'
    }
    domain: any()
    encryptedCredential: any()
    existingClusterId: any()
    instancePoolId: any()
    newClusterCustomTags: {}
    newClusterDriverNodeType: any()
    newClusterEnableElasticDisk: any()
    newClusterInitScripts: any()
    newClusterLogDestination: any()
    newClusterNodeType: any()
    newClusterNumOfWorker: any()
    newClusterSparkConf: {}
    newClusterSparkEnvVars: {}
    newClusterVersion: any()
    policyId: any()
    workspaceResourceId: any()
  }

For AzureDatabricksDeltaLake, use:

  type: 'AzureDatabricksDeltaLake'
  typeProperties: {
    accessToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    clusterId: any()
    domain: any()
    encryptedCredential: any()
  }

For AzureDataExplorer, use:

  type: 'AzureDataExplorer'
  typeProperties: {
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    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: any()
    resourceGroupName: any()
    servicePrincipalId: any()
    servicePrincipalKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    subscriptionId: any()
    tenant: any()
  }

For AzureDataLakeStore, use:

  type: 'AzureDataLakeStore'
  typeProperties: {
    accountName: any()
    azureCloudType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    dataLakeStoreUri: any()
    encryptedCredential: any()
    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: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    connectionString: any()
    encryptedCredential: any()
    fileShare: any()
    host: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        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'
    }
    encryptedCredential: any()
    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'
    }
  }

For AzureMariaDB, use:

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

For AzureML, use:

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

For AzureMLService, use:

  type: 'AzureMLService'
  typeProperties: {
    encryptedCredential: any()
    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: any()
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
  }

For AzurePostgreSql, use:

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

For AzureSearch, use:

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

For AzureSqlDatabase, use:

  type: 'AzureSqlDatabase'
  typeProperties: {
    alwaysEncryptedSettings: {
      alwaysEncryptedAkvAuthType: 'string'
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    encryptedCredential: any()
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        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'
    }
    encryptedCredential: any()
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        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'
      servicePrincipalId: any()
      servicePrincipalKey: {
        type: 'string'
        // For remaining properties, see SecretBase objects
      }
    }
    azureCloudType: any()
    connectionString: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    encryptedCredential: any()
    password: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        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: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    connectionString: any()
    encryptedCredential: 'string'
    sasToken: {
      secretName: any()
      secretVersion: any()
      store: {
        parameters: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    sasUri: any()
  }

For AzureTableStorage, use:

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

For Cassandra, use:

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

For CommonDataServiceForApps, use:

  type: 'CommonDataServiceForApps'
  typeProperties: {
    authenticationType: any()
    deploymentType: any()
    encryptedCredential: any()
    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: any()
    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()
    database: any()
    encryptedCredential: any()
    servicePrincipalCredential: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    servicePrincipalCredentialType: 'string'
    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: {}
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      type: 'string'
    }
    encryptedCredential: any()
  }

For CustomDataSource, use:

  type: 'CustomDataSource'
  typeProperties: any()

For Db2, use:

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

For Drill, use:

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

For Dynamics, use:

  type: 'Dynamics'
  typeProperties: {
    authenticationType: any()
    deploymentType: any()
    encryptedCredential: any()
    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: any()
    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: any()
    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: any()
    endpoint: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
    username: any()
  }

For FileServer, use:

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

For FtpServer, use:

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

For GoogleAdWords, use:

  type: 'GoogleAdWords'
  typeProperties: {
    authenticationType: 'string'
    clientCustomerID: any()
    clientId: any()
    clientSecret: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    developerToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    email: any()
    encryptedCredential: any()
    keyFilePath: any()
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    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: any()
    keyFilePath: any()
    project: any()
    refreshToken: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    requestGoogleDriveScope: any()
    trustedCertPath: any()
    useSystemTrustStore: any()
  }

For GoogleCloudStorage, use:

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

For Greenplum, use:

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

For HBase, use:

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

For Hdfs, use:

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

For HDInsight, use:

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

For HDInsightOnDemand, use:

  type: 'HDInsightOnDemand'
  typeProperties: {
    additionalLinkedServiceNames: [
      {
        parameters: {}
        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'
    }
    dataNodeSize: any()
    encryptedCredential: any()
    hBaseConfiguration: any()
    hcatalogLinkedServiceName: {
      parameters: {}
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    hdfsConfiguration: any()
    headNodeSize: any()
    hiveConfiguration: any()
    hostSubscriptionId: any()
    linkedServiceName: {
      parameters: {}
      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: any()
    host: any()
    httpPath: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    port: any()
    serverType: 'string'
    serviceDiscoveryMode: any()
    thriftTransportProtocol: 'string'
    trustedCertPath: any()
    useNativeQuery: any()
    username: any()
    useSystemTrustStore: any()
    zooKeeperNameSpace: any()
  }

For HttpServer, use:

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

For Hubspot, use:

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

For Impala, use:

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

For Informix, use:

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

For Jira, use:

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

For Magento, use:

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

For MariaDB, use:

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

For Marketo, use:

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

For MicrosoftAccess, use:

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

For MongoDb, use:

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

For MongoDbAtlas, use:

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

For MongoDbV2, use:

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

For MySql, use:

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

For Netezza, use:

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

For OData, use:

  type: 'OData'
  typeProperties: {
    aadResourceId: any()
    aadServicePrincipalCredentialType: 'string'
    authenticationType: 'string'
    authHeaders: any()
    azureCloudType: any()
    encryptedCredential: any()
    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: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    userName: any()
  }

For Office365, use:

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

For Oracle, use:

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

For OracleCloudStorage, use:

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

For OracleServiceCloud, use:

  type: 'OracleServiceCloud'
  typeProperties: {
    encryptedCredential: any()
    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: any()
    host: any()
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For Phoenix, use:

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

For PostgreSql, use:

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

For Presto, use:

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

For QuickBooks, use:

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

For Responsys, use:

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

For RestService, use:

  type: 'RestService'
  typeProperties: {
    aadResourceId: any()
    authenticationType: 'string'
    authHeaders: any()
    azureCloudType: any()
    credential: {
      referenceName: 'string'
      type: 'CredentialReference'
    }
    enableServerCertificateValidation: any()
    encryptedCredential: any()
    password: {
      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 Salesforce, use:

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

For SalesforceMarketingCloud, use:

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

For SalesforceServiceCloud, use:

  type: 'SalesforceServiceCloud'
  typeProperties: {
    apiVersion: any()
    encryptedCredential: any()
    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 SapBW, use:

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

For SapCloudForCustomer, use:

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

For SapEcc, use:

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

For SapHana, use:

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

For SapOpenHub, use:

  type: 'SapOpenHub'
  typeProperties: {
    clientId: any()
    encryptedCredential: any()
    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: any()
    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: any()
    endpoint: any()
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
    username: any()
  }

For Sftp, use:

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

For SharePointOnlineList, use:

  type: 'SharePointOnlineList'
  typeProperties: {
    encryptedCredential: any()
    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: any()
    host: any()
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For Snowflake, use:

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

For Spark, use:

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

For SqlServer, use:

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

For Square, use:

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

For Sybase, use:

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

For Teradata, use:

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

For Vertica, use:

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

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: any()
    host: any()
    privateKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    useEncryptedEndpoints: any()
    useHostVerification: any()
    usePeerVerification: any()
  }

For Zoho, use:

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

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  type: 'AzureKeyVaultSecret'
  secretName: any()
  secretVersion: any()
  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
  }
  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
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataFactory/factories/linkedservices'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-06-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource. LinkedService (required)

LinkedService

Name Description Value
annotations List of tags that can be used for describing the linked service. any[]
connectVia Integration runtime reference type. IntegrationRuntimeReference
description Linked service description. string
parameters Definition of all parameters for an entity. object
type Set the object type AmazonMWS
AmazonRedshift
AmazonS3
AmazonS3Compatible
AzureBatch
AzureBlobFS
AzureBlobStorage
AzureDatabricks
AzureDatabricksDeltaLake
AzureDataExplorer
AzureDataLakeAnalytics
AzureDataLakeStore
AzureFileStorage
AzureFunction
AzureKeyVault
AzureMariaDB
AzureML
AzureMLService
AzureMySql
AzurePostgreSql
AzureSearch
AzureSqlDatabase
AzureSqlDW
AzureSqlMI
AzureStorage
AzureTableStorage
Cassandra
CommonDataServiceForApps
Concur
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomDataSource
Db2
Drill
Dynamics
DynamicsAX
DynamicsCrm
Eloqua
FileServer
FtpServer
GoogleAdWords
GoogleBigQuery
GoogleCloudStorage
Greenplum
HBase
Hdfs
HDInsight
HDInsightOnDemand
Hive
HttpServer
Hubspot
Impala
Informix
Jira
Magento
MariaDB
Marketo
MicrosoftAccess
MongoDb
MongoDbAtlas
MongoDbV2
MySql
Netezza
OData
Odbc
Office365
Oracle
OracleCloudStorage
OracleServiceCloud
Paypal
Phoenix
PostgreSql
Presto
QuickBooks
Responsys
RestService
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SapBW
SapCloudForCustomer
SapEcc
SapHana
SapOpenHub
SapTable
ServiceNow
Sftp
SharePointOnlineList
Shopify
Snowflake
Spark
SqlServer
Square
Sybase
Teradata
Vertica
Web
Xero
Zoho

IntegrationRuntimeReference

Name Description Value
parameters An object mapping parameter names to argument values. object
referenceName Reference integration runtime name. string (required)
type Type of integration runtime. 'IntegrationRuntimeReference'

AmazonMWSLinkedService

Name Description Value
type Type of linked service. 'AmazonMWS'
typeProperties Amazon Marketplace Web Service linked service properties. AmazonMWSLinkedServiceTypeProperties (required)

AmazonMWSLinkedServiceTypeProperties

Name Description Value
accessKeyId Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.(required)
marketplaceID Any object For Bicep, you can use the any() function.(required)
mwsAuthToken The base definition of a secret type. SecretBase
secretKey The base definition of a secret type. SecretBase
sellerID Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

SecretBase

Name Description Value
type Set the object type AzureKeyVaultSecret
SecureString

AzureKeyVaultSecretReference

Name Description Value
secretName Any object For Bicep, you can use the any() function.(required)
secretVersion Any object For Bicep, you can use the any() function.
store Linked service reference type. LinkedServiceReference (required)
type Type of the secret. string (required)

LinkedServiceReference

Name Description Value
parameters An object mapping parameter names to argument values. object
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference'

SecureString

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

AmazonRedshiftLinkedService

Name Description Value
type Type of linked service. 'AmazonRedshift'
typeProperties Amazon Redshift linked service properties. AmazonRedshiftLinkedServiceTypeProperties (required)

AmazonRedshiftLinkedServiceTypeProperties

Name Description Value
database Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
server Any object For Bicep, you can use the any() function.(required)
username Any object For Bicep, you can use the any() function.

AmazonS3LinkedService

Name Description Value
type Type of linked service. 'AmazonS3'
typeProperties Amazon S3 linked service properties. AmazonS3LinkedServiceTypeProperties (required)

AmazonS3LinkedServiceTypeProperties

Name Description Value
accessKeyId Any object For Bicep, you can use the any() function.
authenticationType Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
secretAccessKey The base definition of a secret type. SecretBase
serviceUrl Any object For Bicep, you can use the any() function.
sessionToken The base definition of a secret type. SecretBase

AmazonS3CompatibleLinkedService

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

AmazonS3CompatibleLinkedServiceTypeProperties

Name Description Value
accessKeyId Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
forcePathStyle Any object For Bicep, you can use the any() function.
secretAccessKey The base definition of a secret type. SecretBase
serviceUrl Any object For Bicep, you can use the any() function.

AzureBatchLinkedService

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

AzureBatchLinkedServiceTypeProperties

Name Description Value
accessKey The base definition of a secret type. SecretBase
accountName Any object For Bicep, you can use the any() function.(required)
batchUri Any object For Bicep, you can use the any() function.(required)
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
linkedServiceName Linked service reference type. LinkedServiceReference (required)
poolName Any object For Bicep, you can use the any() function.(required)

CredentialReference

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

AzureBlobFSLinkedService

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

AzureBlobFSLinkedServiceTypeProperties

Name Description Value
accountKey Any object For Bicep, you can use the any() function.
azureCloudType Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.
url Any object For Bicep, you can use the any() function.(required)

AzureBlobStorageLinkedService

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

AzureBlobStorageLinkedServiceTypeProperties

Name Description Value
accountKey Azure Key Vault secret reference. 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). string
azureCloudType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). string
sasToken Azure Key Vault secret reference. AzureKeyVaultSecretReference
sasUri Any object 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. string
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.

AzureDatabricksLinkedService

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

AzureDatabricksLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
authentication Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
domain Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
existingClusterId Any object For Bicep, you can use the any() function.
instancePoolId Any object For Bicep, you can use the any() function.
newClusterCustomTags Additional tags for cluster resources. This property is ignored in instance pool configurations. object
newClusterDriverNodeType Any object For Bicep, you can use the any() function.
newClusterEnableElasticDisk Any object For Bicep, you can use the any() function.
newClusterInitScripts Any object For Bicep, you can use the any() function.
newClusterLogDestination Any object For Bicep, you can use the any() function.
newClusterNodeType Any object For Bicep, you can use the any() function.
newClusterNumOfWorker Any object For Bicep, you can use the any() function.
newClusterSparkConf A set of optional, user-specified Spark configuration key-value pairs. object
newClusterSparkEnvVars A set of optional, user-specified Spark environment variables key-value pairs. object
newClusterVersion Any object For Bicep, you can use the any() function.
policyId Any object For Bicep, you can use the any() function.
workspaceResourceId Any object For Bicep, you can use the any() function.

AzureDatabricksDeltaLakeLinkedService

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

AzureDatabricksDetltaLakeLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
clusterId Any object For Bicep, you can use the any() function.
domain Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.

AzureDataExplorerLinkedService

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

AzureDataExplorerLinkedServiceTypeProperties

Name Description Value
credential Credential reference type. CredentialReference
database Any object For Bicep, you can use the any() function.(required)
endpoint Any object For Bicep, you can use the any() function.(required)
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.

AzureDataLakeAnalyticsLinkedService

Name Description Value
type Type of linked service. 'AzureDataLakeAnalytics'
typeProperties Azure Data Lake Analytics linked service properties. AzureDataLakeAnalyticsLinkedServiceTypeProperties (required)

AzureDataLakeAnalyticsLinkedServiceTypeProperties

Name Description Value
accountName Any object For Bicep, you can use the any() function.(required)
dataLakeAnalyticsUri Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
resourceGroupName Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
subscriptionId Any object For Bicep, you can use the any() function.
tenant Any object For Bicep, you can use the any() function.(required)

AzureDataLakeStoreLinkedService

Name Description Value
type Type of linked service. 'AzureDataLakeStore'
typeProperties Azure Data Lake Store linked service properties. AzureDataLakeStoreLinkedServiceTypeProperties (required)

AzureDataLakeStoreLinkedServiceTypeProperties

Name Description Value
accountName Any object For Bicep, you can use the any() function.
azureCloudType Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
dataLakeStoreUri Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
resourceGroupName Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
subscriptionId Any object For Bicep, you can use the any() function.
tenant Any object For Bicep, you can use the any() function.

AzureFileStorageLinkedService

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

AzureFileStorageLinkedServiceTypeProperties

Name Description Value
accountKey Azure Key Vault secret reference. AzureKeyVaultSecretReference
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
fileShare Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
sasToken Azure Key Vault secret reference. AzureKeyVaultSecretReference
sasUri Any object For Bicep, you can use the any() function.
snapshot Any object For Bicep, you can use the any() function.
userId Any object For Bicep, you can use the any() function.

AzureFunctionLinkedService

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

AzureFunctionLinkedServiceTypeProperties

Name Description Value
authentication Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
functionAppUrl Any object For Bicep, you can use the any() function.(required)
functionKey The base definition of a secret type. SecretBase
resourceId Any object For Bicep, you can use the any() function.

AzureKeyVaultLinkedService

Name Description Value
type Type of linked service. 'AzureKeyVault'
typeProperties Azure Key Vault linked service properties. AzureKeyVaultLinkedServiceTypeProperties (required)

AzureKeyVaultLinkedServiceTypeProperties

Name Description Value
baseUrl Any object For Bicep, you can use the any() function.(required)
credential Credential reference type. CredentialReference

AzureMariaDBLinkedService

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

AzureMariaDBLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

AzureMLLinkedService

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

AzureMLLinkedServiceTypeProperties

Name Description Value
apiKey The base definition of a secret type. SecretBase (required)
authentication Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
mlEndpoint Any object For Bicep, you can use the any() function.(required)
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.
updateResourceEndpoint Any object For Bicep, you can use the any() function.

AzureMLServiceLinkedService

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

AzureMLServiceLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
mlWorkspaceName Any object For Bicep, you can use the any() function.(required)
resourceGroupName Any object For Bicep, you can use the any() function.(required)
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
subscriptionId Any object For Bicep, you can use the any() function.(required)
tenant Any object For Bicep, you can use the any() function.

AzureMySqlLinkedService

Name Description Value
type Type of linked service. 'AzureMySql'
typeProperties Azure MySQL database linked service properties. AzureMySqlLinkedServiceTypeProperties (required)

AzureMySqlLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

AzurePostgreSqlLinkedService

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

AzurePostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

AzureSearchLinkedService

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

AzureSearchLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
key The base definition of a secret type. SecretBase
url Any object For Bicep, you can use the any() function.(required)

AzureSqlDatabaseLinkedService

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

AzureSqlDatabaseLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.

SqlAlwaysEncryptedProperties

Name Description Value
alwaysEncryptedAkvAuthType Sql always encrypted AKV authentication type. Type: string (or Expression with resultType string). 'ManagedIdentity'
'ServicePrincipal'
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase

AzureSqlDWLinkedService

Name Description Value
type Type of linked service. 'AzureSqlDW'
typeProperties Azure SQL Data Warehouse linked service properties. AzureSqlDWLinkedServiceTypeProperties (required)

AzureSqlDWLinkedServiceTypeProperties

Name Description Value
azureCloudType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.

AzureSqlMILinkedService

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

AzureSqlMILinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
azureCloudType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential Credential reference type. CredentialReference
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.

AzureStorageLinkedService

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

AzureStorageLinkedServiceTypeProperties

Name Description Value
accountKey Azure Key Vault secret reference. AzureKeyVaultSecretReference
connectionString Any 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 (or Expression with resultType string). string
sasToken Azure Key Vault secret reference. AzureKeyVaultSecretReference
sasUri Any object For Bicep, you can use the any() function.

AzureTableStorageLinkedService

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

CassandraLinkedService

Name Description Value
type Type of linked service. 'Cassandra'
typeProperties Cassandra linked service properties. CassandraLinkedServiceTypeProperties (required)

CassandraLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

CommonDataServiceForAppsLinkedService

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

CommonDataServiceForAppsLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.(required)
deploymentType Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
hostName Any object For Bicep, you can use the any() function.
organizationName Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
servicePrincipalCredential The base definition of a secret type. SecretBase
servicePrincipalCredentialType Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
serviceUri Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

ConcurLinkedService

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

ConcurLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.(required)
connectionProperties Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.(required)

CosmosDbLinkedService

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

CosmosDbLinkedServiceTypeProperties

Name Description Value
accountEndpoint Any object For Bicep, you can use the any() function.
accountKey The base definition of a secret type. SecretBase
azureCloudType Any object For Bicep, you can use the any() function.
connectionMode The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string). 'Direct'
'Gateway'
connectionString Any object For Bicep, you can use the any() function.
database Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
servicePrincipalCredential The base definition of a secret type. 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). 'ServicePrincipalCert'
'ServicePrincipalKey'
servicePrincipalId Any object For Bicep, you can use the any() function.
tenant Any object For Bicep, you can use the any() function.

CosmosDbMongoDbApiLinkedService

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

CosmosDbMongoDbApiLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
database Any object For Bicep, you can use the any() function.(required)
isServerVersionAbove32 Any object For Bicep, you can use the any() function.

CouchbaseLinkedService

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

CouchbaseLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
credString Azure Key Vault secret reference. AzureKeyVaultSecretReference
encryptedCredential Any object For Bicep, you can use the any() function.

CustomDataSourceLinkedService

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

Db2LinkedService

Name Description Value
type Type of linked service. 'Db2'
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 Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.
database Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
packageCollection Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

DrillLinkedService

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

DrillLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

DynamicsLinkedService

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

DynamicsLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.(required)
deploymentType Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
hostName Any object For Bicep, you can use the any() function.
organizationName Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
servicePrincipalCredential The base definition of a secret type. SecretBase
servicePrincipalCredentialType Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
serviceUri Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

DynamicsAXLinkedService

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

DynamicsAXLinkedServiceTypeProperties

Name Description Value
aadResourceId Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.(required)
servicePrincipalKey The base definition of a secret type. SecretBase (required)
tenant Any object For Bicep, you can use the any() function.(required)
url Any object For Bicep, you can use the any() function.(required)

DynamicsCrmLinkedService

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

DynamicsCrmLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.(required)
deploymentType Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
hostName Any object For Bicep, you can use the any() function.
organizationName Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
servicePrincipalCredential The base definition of a secret type. SecretBase
servicePrincipalCredentialType Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.
serviceUri Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

EloquaLinkedService

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

EloquaLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.(required)

FileServerLinkedService

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

FileServerLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
userId Any object For Bicep, you can use the any() function.

FtpServerLinkedService

Name Description Value
type Type of linked service. 'FtpServer'
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 Any object For Bicep, you can use the any() function.
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
userName Any object For Bicep, you can use the any() function.

GoogleAdWordsLinkedService

Name Description Value
type Type of linked service. 'GoogleAdWords'
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 Any object For Bicep, you can use the any() function.(required)
clientId Any object For Bicep, you can use the any() function.
clientSecret The base definition of a secret type. SecretBase
developerToken The base definition of a secret type. SecretBase (required)
email Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
keyFilePath Any object For Bicep, you can use the any() function.
refreshToken The base definition of a secret type. SecretBase
trustedCertPath Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

GoogleBigQueryLinkedService

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

GoogleBigQueryLinkedServiceTypeProperties

Name Description Value
additionalProjects Any object 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'
clientId Any object For Bicep, you can use the any() function.
clientSecret The base definition of a secret type. SecretBase
email Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
keyFilePath Any object For Bicep, you can use the any() function.
project Any object For Bicep, you can use the any() function.(required)
refreshToken The base definition of a secret type. SecretBase
requestGoogleDriveScope Any object For Bicep, you can use the any() function.
trustedCertPath Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

GoogleCloudStorageLinkedService

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

GoogleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
secretAccessKey The base definition of a secret type. SecretBase
serviceUrl Any object For Bicep, you can use the any() function.

GreenplumLinkedService

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

GreenplumLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

HBaseLinkedService

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

HBaseLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication mechanism to use to connect to the HBase server. 'Anonymous'
'Basic'
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
httpPath Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
trustedCertPath Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

HdfsLinkedService

Name Description Value
type Type of linked service. 'Hdfs'
typeProperties HDFS linked service properties. HdfsLinkedServiceTypeProperties (required)

HdfsLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
url Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.

HDInsightLinkedService

Name Description Value
type Type of linked service. 'HDInsight'
typeProperties HDInsight linked service properties. HDInsightLinkedServiceTypeProperties (required)

HDInsightLinkedServiceTypeProperties

Name Description Value
clusterUri Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
fileSystem Any object For Bicep, you can use the any() function.
hcatalogLinkedServiceName Linked service reference type. LinkedServiceReference
isEspEnabled Any object For Bicep, you can use the any() function.
linkedServiceName Linked service reference type. LinkedServiceReference
password The base definition of a secret type. SecretBase
userName Any object For Bicep, you can use the any() function.

HDInsightOnDemandLinkedService

Name Description Value
type Type of linked service. 'HDInsightOnDemand'
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 Any object For Bicep, you can use the any() function.
clusterPassword The base definition of a secret type. SecretBase
clusterResourceGroup Any object For Bicep, you can use the any() function.(required)
clusterSize Any object For Bicep, you can use the any() function.(required)
clusterSshPassword The base definition of a secret type. SecretBase
clusterSshUserName Any object For Bicep, you can use the any() function.
clusterType Any object For Bicep, you can use the any() function.
clusterUserName Any object For Bicep, you can use the any() function.
coreConfiguration Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
dataNodeSize Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
hBaseConfiguration Any object For Bicep, you can use the any() function.
hcatalogLinkedServiceName Linked service reference type. LinkedServiceReference
hdfsConfiguration Any object For Bicep, you can use the any() function.
headNodeSize Any object For Bicep, you can use the any() function.
hiveConfiguration Any object For Bicep, you can use the any() function.
hostSubscriptionId Any object For Bicep, you can use the any() function.(required)
linkedServiceName Linked service reference type. LinkedServiceReference (required)
mapReduceConfiguration Any object For Bicep, you can use the any() function.
oozieConfiguration Any object 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 Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
sparkVersion Any object For Bicep, you can use the any() function.
stormConfiguration Any object For Bicep, you can use the any() function.
subnetName Any object For Bicep, you can use the any() function.
tenant Any object For Bicep, you can use the any() function.(required)
timeToLive Any object For Bicep, you can use the any() function.(required)
version Any object For Bicep, you can use the any() function.(required)
virtualNetworkId Any object For Bicep, you can use the any() function.
yarnConfiguration Any object For Bicep, you can use the any() function.
zookeeperNodeSize Any object 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 Any object 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'
typeProperties Hive Server linked service properties. HiveLinkedServiceTypeProperties (required)

HiveLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication method used to access the Hive server. 'Anonymous'
'Username'
'UsernameAndPassword'
'WindowsAzureHDInsightService'
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
httpPath Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
serverType The type of Hive server. 'HiveServer1'
'HiveServer2'
'HiveThriftServer'
serviceDiscoveryMode Any object For Bicep, you can use the any() function.
thriftTransportProtocol The transport protocol to use in the Thrift layer. 'Binary'
'HTTP '
'SASL'
trustedCertPath Any object For Bicep, you can use the any() function.
useNativeQuery Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.
zooKeeperNameSpace Any object For Bicep, you can use the any() function.

HttpLinkedService

Name Description Value
type Type of linked service. 'HttpServer'
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 Any object For Bicep, you can use the any() function.
certThumbprint Any object For Bicep, you can use the any() function.
embeddedCertData Any object For Bicep, you can use the any() function.
enableServerCertificateValidation Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
url Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.

HubspotLinkedService

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

HubspotLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
clientId Any object For Bicep, you can use the any() function.(required)
clientSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
refreshToken The base definition of a secret type. SecretBase
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

ImpalaLinkedService

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

ImpalaLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication type to use. 'Anonymous'
'SASLUsername'
'UsernameAndPassword'
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
trustedCertPath Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

InformixLinkedService

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

InformixLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
userName Any object For Bicep, you can use the any() function.

JiraLinkedService

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

JiraLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.(required)

MagentoLinkedService

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

MagentoLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

MariaDBLinkedService

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

MariaDBLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

MarketoLinkedService

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

MarketoLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.(required)
clientSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

MicrosoftAccessLinkedService

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

MicrosoftAccessLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
userName Any object For Bicep, you can use the any() function.

MongoDbLinkedService

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

MongoDbLinkedServiceTypeProperties

Name Description Value
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication type to be used to connect to the MongoDB database. 'Anonymous'
'Basic'
authSource Any object For Bicep, you can use the any() function.
databaseName Any object For Bicep, you can use the any() function.(required)
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
server Any object For Bicep, you can use the any() function.(required)
username Any object For Bicep, you can use the any() function.

MongoDbAtlasLinkedService

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

MongoDbAtlasLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
database Any object For Bicep, you can use the any() function.(required)

MongoDbV2LinkedService

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

MongoDbV2LinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
database Any object For Bicep, you can use the any() function.(required)

MySqlLinkedService

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

MySqlLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

NetezzaLinkedService

Name Description Value
type Type of linked service. 'Netezza'
typeProperties Netezza linked service properties. NetezzaLinkedServiceTypeProperties (required)

NetezzaLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

ODataLinkedService

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

ODataLinkedServiceTypeProperties

Name Description Value
aadResourceId Any object 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 Any object For Bicep, you can use the any() function.
azureCloudType Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
servicePrincipalEmbeddedCert The base definition of a secret type. SecretBase
servicePrincipalEmbeddedCertPassword The base definition of a secret type. SecretBase
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.
url Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.

OdbcLinkedService

Name Description Value
type Type of linked service. 'Odbc'
typeProperties ODBC linked service properties. OdbcLinkedServiceTypeProperties (required)

OdbcLinkedServiceTypeProperties

Name Description Value
authenticationType Any object For Bicep, you can use the any() function.
connectionString Any object For Bicep, you can use the any() function.(required)
credential The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
userName Any object For Bicep, you can use the any() function.

Office365LinkedService

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

Office365LinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
office365TenantId Any object For Bicep, you can use the any() function.(required)
servicePrincipalId Any object For Bicep, you can use the any() function.(required)
servicePrincipalKey The base definition of a secret type. SecretBase (required)
servicePrincipalTenantId Any object For Bicep, you can use the any() function.(required)

OracleLinkedService

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

OracleLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

OracleCloudStorageLinkedService

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

OracleCloudStorageLinkedServiceTypeProperties

Name Description Value
accessKeyId Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
secretAccessKey The base definition of a secret type. SecretBase
serviceUrl Any object For Bicep, you can use the any() function.

OracleServiceCloudLinkedService

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

OracleServiceCloudLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase (required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.(required)

PaypalLinkedService

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

PaypalLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.(required)
clientSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

PhoenixLinkedService

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

PhoenixLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication mechanism used to connect to the Phoenix server. 'Anonymous'
'UsernameAndPassword'
'WindowsAzureHDInsightService'
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
httpPath Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
trustedCertPath Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

PostgreSqlLinkedService

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

PostgreSqlLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

PrestoLinkedService

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

PrestoLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication mechanism used to connect to the Presto server. 'Anonymous'
'LDAP'
catalog Any object For Bicep, you can use the any() function.(required)
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
serverVersion Any object For Bicep, you can use the any() function.(required)
timeZoneID Any object For Bicep, you can use the any() function.
trustedCertPath Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

QuickBooksLinkedService

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

QuickBooksLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
accessTokenSecret The base definition of a secret type. SecretBase
companyId Any object For Bicep, you can use the any() function.
connectionProperties Any object For Bicep, you can use the any() function.
consumerKey Any object For Bicep, you can use the any() function.
consumerSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.
useEncryptedEndpoints Any object For Bicep, you can use the any() function.

ResponsysLinkedService

Name Description Value
type Type of linked service. 'Responsys'
typeProperties Responsys linked service properties. ResponsysLinkedServiceTypeProperties (required)

ResponsysLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.(required)
clientSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

RestServiceLinkedService

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

RestServiceLinkedServiceTypeProperties

Name Description Value
aadResourceId Any object For Bicep, you can use the any() function.
authenticationType Type of authentication used to connect to the REST service. 'AadServicePrincipal'
'Anonymous'
'Basic'
'ManagedServiceIdentity'
authHeaders Any object For Bicep, you can use the any() function.
azureCloudType Any object For Bicep, you can use the any() function.
credential Credential reference type. CredentialReference
enableServerCertificateValidation Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
servicePrincipalId Any object For Bicep, you can use the any() function.
servicePrincipalKey The base definition of a secret type. SecretBase
tenant Any object For Bicep, you can use the any() function.
url Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.

SalesforceLinkedService

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

SalesforceLinkedServiceTypeProperties

Name Description Value
apiVersion Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
environmentUrl Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
securityToken The base definition of a secret type. SecretBase
username Any object For Bicep, you can use the any() function.

SalesforceMarketingCloudLinkedService

Name Description Value
type Type of linked service. 'SalesforceMarketingCloud'
typeProperties Salesforce Marketing Cloud linked service properties. SalesforceMarketingCloudLinkedServiceTypeProperties (required)

SalesforceMarketingCloudLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.
clientSecret The base definition of a secret type. SecretBase
connectionProperties Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

SalesforceServiceCloudLinkedService

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

SalesforceServiceCloudLinkedServiceTypeProperties

Name Description Value
apiVersion Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
environmentUrl Any object For Bicep, you can use the any() function.
extendedProperties Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
securityToken The base definition of a secret type. SecretBase
username Any object For Bicep, you can use the any() function.

SapBWLinkedService

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

SapBWLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.(required)
systemNumber Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.

SapCloudForCustomerLinkedService

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

SapCloudForCustomerLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
url Any object For Bicep, you can use the any() function.(required)
username Any object For Bicep, you can use the any() function.

SapEccLinkedService

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

SapEccLinkedServiceTypeProperties

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

SapHanaLinkedService

Name Description Value
type Type of linked service. 'SapHana'
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 Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.
userName Any object For Bicep, you can use the any() function.

SapOpenHubLinkedService

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

SapOpenHubLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
language Any object For Bicep, you can use the any() function.
logonGroup Any object For Bicep, you can use the any() function.
messageServer Any object For Bicep, you can use the any() function.
messageServerService Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.
systemId Any object For Bicep, you can use the any() function.
systemNumber Any object For Bicep, you can use the any() function.
userName Any object For Bicep, you can use the any() function.

SapTableLinkedService

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

SapTableLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
language Any object For Bicep, you can use the any() function.
logonGroup Any object For Bicep, you can use the any() function.
messageServer Any object For Bicep, you can use the any() function.
messageServerService Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.
sncLibraryPath Any object For Bicep, you can use the any() function.
sncMode Any object For Bicep, you can use the any() function.
sncMyName Any object For Bicep, you can use the any() function.
sncPartnerName Any object For Bicep, you can use the any() function.
sncQop Any object For Bicep, you can use the any() function.
systemId Any object For Bicep, you can use the any() function.
systemNumber Any object For Bicep, you can use the any() function.
userName Any object For Bicep, you can use the any() function.

ServiceNowLinkedService

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

ServiceNowLinkedServiceTypeProperties

Name Description Value
authenticationType The authentication type to use. 'Basic'
'OAuth2'
clientId Any object For Bicep, you can use the any() function.
clientSecret The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.(required)
password The base definition of a secret type. SecretBase
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

SftpServerLinkedService

Name Description Value
type Type of linked service. 'Sftp'
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 Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
hostKeyFingerprint Any object For Bicep, you can use the any() function.
passPhrase The base definition of a secret type. SecretBase
password The base definition of a secret type. SecretBase
port Any object For Bicep, you can use the any() function.
privateKeyContent The base definition of a secret type. SecretBase
privateKeyPath Any object For Bicep, you can use the any() function.
skipHostKeyValidation Any object For Bicep, you can use the any() function.
userName Any object For Bicep, you can use the any() function.

SharePointOnlineListLinkedService

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

SharePointOnlineListLinkedServiceTypeProperties

Name Description Value
encryptedCredential Any object For Bicep, you can use the any() function.
servicePrincipalId Any object For Bicep, you can use the any() function.(required)
servicePrincipalKey The base definition of a secret type. SecretBase (required)
siteUrl Any object For Bicep, you can use the any() function.(required)
tenantId Any object For Bicep, you can use the any() function.(required)

ShopifyLinkedService

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

ShopifyLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

SnowflakeLinkedService

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

SnowflakeLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password Azure Key Vault secret reference. AzureKeyVaultSecretReference

SparkLinkedService

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

SparkLinkedServiceTypeProperties

Name Description Value
allowHostNameCNMismatch Any object For Bicep, you can use the any() function.
allowSelfSignedServerCert Any object For Bicep, you can use the any() function.
authenticationType The authentication method used to access the Spark server. 'Anonymous'
'Username'
'UsernameAndPassword'
'WindowsAzureHDInsightService'
enableSsl Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.(required)
httpPath Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
port Any object 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 Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.
useSystemTrustStore Any object For Bicep, you can use the any() function.

SqlServerLinkedService

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

SqlServerLinkedServiceTypeProperties

Name Description Value
alwaysEncryptedSettings Sql always encrypted properties. SqlAlwaysEncryptedProperties
connectionString Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
userName Any object For Bicep, you can use the any() function.

SquareLinkedService

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

SquareLinkedServiceTypeProperties

Name Description Value
clientId Any object For Bicep, you can use the any() function.
clientSecret The base definition of a secret type. SecretBase
connectionProperties Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.
redirectUri Any object For Bicep, you can use the any() function.
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

SybaseLinkedService

Name Description Value
type Type of linked service. 'Sybase'
typeProperties Sybase linked service properties. SybaseLinkedServiceTypeProperties (required)

SybaseLinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. 'Basic'
'Windows'
database Any object For Bicep, you can use the any() function.(required)
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
schema Any object For Bicep, you can use the any() function.
server Any object For Bicep, you can use the any() function.(required)
username Any object For Bicep, you can use the any() function.

TeradataLinkedService

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

TeradataLinkedServiceTypeProperties

Name Description Value
authenticationType AuthenticationType to be used for connection. 'Basic'
'Windows'
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
password The base definition of a secret type. SecretBase
server Any object For Bicep, you can use the any() function.
username Any object For Bicep, you can use the any() function.

VerticaLinkedService

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

VerticaLinkedServiceTypeProperties

Name Description Value
connectionString Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
pwd Azure Key Vault secret reference. AzureKeyVaultSecretReference

WebLinkedService

Name Description Value
type Type of linked service. 'Web'
typeProperties Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. WebLinkedServiceTypeProperties (required)

WebLinkedServiceTypeProperties

Name Description Value
url Any object For Bicep, you can use the any() function.(required)
authenticationType Set the object type Anonymous
Basic
ClientCertificate

WebAnonymousAuthentication

Name Description Value
authenticationType Type of authentication used to connect to the web table source. 'Anonymous'

WebBasicAuthentication

Name Description Value
authenticationType Type of authentication used to connect to the web table source. 'Basic'
password The base definition of a secret type. SecretBase (required)
username Any object 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'
password The base definition of a secret type. SecretBase (required)
pfx The base definition of a secret type. SecretBase (required)

XeroLinkedService

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

XeroLinkedServiceTypeProperties

Name Description Value
connectionProperties Any object For Bicep, you can use the any() function.
consumerKey The base definition of a secret type. SecretBase
encryptedCredential Any object For Bicep, you can use the any() function.
host Any object For Bicep, you can use the any() function.
privateKey The base definition of a secret type. SecretBase
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

ZohoLinkedService

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

ZohoLinkedServiceTypeProperties

Name Description Value
accessToken The base definition of a secret type. SecretBase
connectionProperties Any object For Bicep, you can use the any() function.
encryptedCredential Any object For Bicep, you can use the any() function.
endpoint Any object For Bicep, you can use the any() function.
useEncryptedEndpoints Any object For Bicep, you can use the any() function.
useHostVerification Any object For Bicep, you can use the any() function.
usePeerVerification Any object For Bicep, you can use the any() function.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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

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

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

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

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

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.