Share via

HDInsightOnDemandLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

HDInsight ondemand linked service.

Extends
LinkedService

Properties

additionalLinkedServiceNames

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

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

The password to access the cluster.
clusterResourceGroup

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

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

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

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

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

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

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

The credential reference containing authentication information.
dataNodeSize

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

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

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

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

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

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

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

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

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

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

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

Custom script actions to run on HDI ondemand cluster once it's up. Please refer to 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.
servicePrincipalId

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

The key for the service principal id.
sparkVersion

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

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

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

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

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

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

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

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

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

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

Inherited Properties

annotations

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

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.

Property Details

additionalLinkedServiceNames

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

LinkedServiceReference[]

clusterNamePrefix

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

clusterNamePrefix?: any

Property Value

any

clusterPassword

The password to access the cluster.

clusterPassword?: SecretBaseUnion

Property Value

SecretBaseUnion

clusterResourceGroup

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

clusterResourceGroup: any

Property Value

any

clusterSize

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

clusterSize: any

Property Value

any

clusterSshPassword

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

clusterSshPassword?: SecretBaseUnion

Property Value

SecretBaseUnion

clusterSshUserName

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

clusterSshUserName?: any

Property Value

any

clusterType

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

clusterType?: any

Property Value

any

clusterUserName

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

clusterUserName?: any

Property Value

any

coreConfiguration

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

coreConfiguration?: any

Property Value

any

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

dataNodeSize

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

dataNodeSize?: any

Property Value

any

encryptedCredential

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

encryptedCredential?: string

Property Value

string

hBaseConfiguration

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

hBaseConfiguration?: any

Property Value

any

hcatalogLinkedServiceName

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

hcatalogLinkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

hdfsConfiguration

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

hdfsConfiguration?: any

Property Value

any

headNodeSize

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

headNodeSize?: any

Property Value

any

hiveConfiguration

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

hiveConfiguration?: any

Property Value

any

hostSubscriptionId

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

hostSubscriptionId: any

Property Value

any

linkedServiceName

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

linkedServiceName: LinkedServiceReference

Property Value

LinkedServiceReference

mapReduceConfiguration

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

mapReduceConfiguration?: any

Property Value

any

oozieConfiguration

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

oozieConfiguration?: any

Property Value

any

scriptActions

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

ScriptAction[]

servicePrincipalId

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

servicePrincipalId?: any

Property Value

any

servicePrincipalKey

The key for the service principal id.

servicePrincipalKey?: SecretBaseUnion

Property Value

SecretBaseUnion

sparkVersion

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

sparkVersion?: any

Property Value

any

stormConfiguration

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

stormConfiguration?: any

Property Value

any

subnetName

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

subnetName?: any

Property Value

any

tenant

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

tenant: any

Property Value

any

timeToLive

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

timeToLive: any

Property Value

any

type

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

type: "HDInsightOnDemand"

Property Value

"HDInsightOnDemand"

version

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

version: any

Property Value

any

virtualNetworkId

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

any

yarnConfiguration

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

yarnConfiguration?: any

Property Value

any

zookeeperNodeSize

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

zookeeperNodeSize?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

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

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters