HDInsightOnDemandLinkedService interface

Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.

additionalLinkedServiceNames?: LinkedServiceReference[]

Property Value

The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).

clusterNamePrefix?: any

Property Value

The password to access the cluster.

clusterPassword?: SecretBaseUnion

Property Value

The resource group where the cluster belongs. Type: string (or Expression with resultType string).

clusterResourceGroup: any

Property Value

Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).

clusterSize: any

Property Value

The password to SSH remotely connect cluster’s node (for Linux).

clusterSshPassword?: SecretBaseUnion

Property Value

The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).

clusterSshUserName?: any

Property Value

The cluster type. Type: string (or Expression with resultType string).

clusterType?: any

Property Value

The username to access the cluster. Type: string (or Expression with resultType string).

clusterUserName?: any

Property Value

Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.

coreConfiguration?: any

Property Value

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

Specifies the size of the data node for the HDInsight cluster.

dataNodeSize?: any

Property Value

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.

hBaseConfiguration?: any

Property Value

The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.

hcatalogLinkedServiceName?: LinkedServiceReference

Property Value

Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.

hdfsConfiguration?: any

Property Value

Specifies the size of the head node for the HDInsight cluster.

headNodeSize?: any

Property Value

Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.

hiveConfiguration?: any

Property Value

The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).

hostSubscriptionId: any

Property Value

Azure Storage linked service to be used by the on-demand cluster for storing and processing data.

linkedServiceName: LinkedServiceReference

Property Value

Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.

mapReduceConfiguration?: any

Property Value

Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.

oozieConfiguration?: any

Property Value

Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.

scriptActions?: ScriptAction[]

Property Value

The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).

servicePrincipalId?: any

Property Value

The key for the service principal id.

servicePrincipalKey?: SecretBaseUnion

Property Value

The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).

sparkVersion?: any

Property Value

Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.

stormConfiguration?: any

Property Value

The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).

subnetName?: any

Property Value

The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).

tenant: any

Property Value

The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).

timeToLive: any

Property Value

Polymorphic discriminator, which specifies the different types this object can be

type: "HDInsightOnDemand"

Property Value

Version of the HDInsight cluster.  Type: string (or Expression with resultType string).

versionTypePropertiesVersion: any

Property Value

The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).

virtualNetworkId?: any

Property Value

Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.

yarnConfiguration?: any

Property Value

Specifies the size of the Zoo Keeper node for the HDInsight cluster.

zookeeperNodeSize?: any

Property Value

List of tags that can be used for describing the linked service.

annotations?: any[]

Property Value

Inherited From LinkedService.annotations

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

Inherited From LinkedService.connectVia

Linked service description.

description?: string

Property Value

Inherited From LinkedService.description

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

Inherited From LinkedService.parameters

Version of the linked service.

version?: string

Property Value

Inherited From LinkedService.version