Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HDInsightOnDemandLinkedService

Package version

HDInsight ondemand linked service.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional additionalLinkedServiceNames

additionalLinkedServiceNames: LinkedServiceReference[]

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

Optional annotations

annotations: any[]

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

Optional clusterNamePrefix

clusterNamePrefix: any

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

Optional clusterPassword

clusterPassword: SecretBaseUnion

The password to access the cluster.

clusterResourceGroup

clusterResourceGroup: any

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

clusterSize

clusterSize: any

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

Optional clusterSshPassword

clusterSshPassword: SecretBaseUnion

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

Optional clusterSshUserName

clusterSshUserName: any

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

Optional clusterType

clusterType: any

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

Optional clusterUserName

clusterUserName: any

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

Optional connectVia

The integration runtime reference.

Optional coreConfiguration

coreConfiguration: any

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

Optional dataNodeSize

dataNodeSize: any

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

Optional description

description: undefined | string

Linked service description.

Optional encryptedCredential

encryptedCredential: any

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional hBaseConfiguration

hBaseConfiguration: any

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

Optional hcatalogLinkedServiceName

hcatalogLinkedServiceName: LinkedServiceReference

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.

Optional hdfsConfiguration

hdfsConfiguration: any

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

Optional headNodeSize

headNodeSize: any

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

Optional hiveConfiguration

hiveConfiguration: any

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

hostSubscriptionId

hostSubscriptionId: any

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

linkedServiceName

linkedServiceName: LinkedServiceReference

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

Optional mapReduceConfiguration

mapReduceConfiguration: any

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

Optional oozieConfiguration

oozieConfiguration: any

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

Optional parameters

parameters: undefined | {}

Parameters for linked service.

Optional scriptActions

scriptActions: ScriptAction[]

Optional servicePrincipalId

servicePrincipalId: any

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

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion

The key for the service principal id.

Optional sparkVersion

sparkVersion: any

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

Optional stormConfiguration

stormConfiguration: any

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

Optional subnetName

subnetName: any

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

tenant: any

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

timeToLive

timeToLive: any

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

type: "HDInsightOnDemand"

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

version

version: any

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

Optional virtualNetworkId

virtualNetworkId: any

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

Optional yarnConfiguration

yarnConfiguration: any

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

Optional zookeeperNodeSize

zookeeperNodeSize: any

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

Generated using TypeDoc