Package version:

Interface HDInsightOnDemandLinkedService

HDInsight ondemand linked service.

interface HDInsightOnDemandLinkedService {
    additionalLinkedServiceNames?: LinkedServiceReference[];
    annotations?: any[];
    clusterNamePrefix?: any;
    clusterPassword?: SecretBaseUnion;
    clusterResourceGroup: any;
    clusterSize: any;
    clusterSshPassword?: SecretBaseUnion;
    clusterSshUserName?: any;
    clusterType?: any;
    clusterUserName?: any;
    connectVia?: IntegrationRuntimeReference;
    coreConfiguration?: any;
    credential?: CredentialReference;
    dataNodeSize?: any;
    description?: string;
    encryptedCredential?: string;
    hBaseConfiguration?: any;
    hcatalogLinkedServiceName?: LinkedServiceReference;
    hdfsConfiguration?: any;
    headNodeSize?: any;
    hiveConfiguration?: any;
    hostSubscriptionId: any;
    linkedServiceName: LinkedServiceReference;
    mapReduceConfiguration?: any;
    oozieConfiguration?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    scriptActions?: ScriptAction[];
    servicePrincipalId?: any;
    servicePrincipalKey?: SecretBaseUnion;
    sparkVersion?: any;
    stormConfiguration?: any;
    subnetName?: any;
    tenant: any;
    timeToLive: any;
    type: "HDInsightOnDemand";
    version?: string;
    versionTypePropertiesVersion: any;
    virtualNetworkId?: any;
    yarnConfiguration?: any;
    zookeeperNodeSize?: any;
}

Hierarchy (view full)

Properties

additionalLinkedServiceNames? annotations? clusterNamePrefix? clusterPassword? clusterResourceGroup clusterSize clusterSshPassword? clusterSshUserName? clusterType? clusterUserName? connectVia? coreConfiguration? credential? dataNodeSize? description? encryptedCredential? hBaseConfiguration? hcatalogLinkedServiceName? hdfsConfiguration? headNodeSize? hiveConfiguration? hostSubscriptionId linkedServiceName mapReduceConfiguration? oozieConfiguration? parameters? scriptActions? servicePrincipalId? servicePrincipalKey? sparkVersion? stormConfiguration? subnetName? tenant timeToLive type version? versionTypePropertiesVersion virtualNetworkId? yarnConfiguration? zookeeperNodeSize?

Properties

OptionaladditionalLinkedServiceNames

additionalLinkedServiceNames?: LinkedServiceReference[]

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

Optionalannotations

annotations?: any[]

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

OptionalclusterNamePrefix

clusterNamePrefix?: any

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

OptionalclusterPassword

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: int (or Expression with resultType int).

OptionalclusterSshPassword

clusterSshPassword?: SecretBaseUnion

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

OptionalclusterSshUserName

clusterSshUserName?: any

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

OptionalclusterType

clusterType?: any

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

OptionalclusterUserName

clusterUserName?: any

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

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

OptionalcoreConfiguration

coreConfiguration?: any

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

Optionalcredential

credential?: CredentialReference

The credential reference containing authentication information.

OptionaldataNodeSize

dataNodeSize?: any

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

Optionaldescription

description?: string

Linked service description.

OptionalencryptedCredential

encryptedCredential?: string

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

OptionalhBaseConfiguration

hBaseConfiguration?: any

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

OptionalhcatalogLinkedServiceName

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.

OptionalhdfsConfiguration

hdfsConfiguration?: any

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

OptionalheadNodeSize

headNodeSize?: any

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

OptionalhiveConfiguration

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.

OptionalmapReduceConfiguration

mapReduceConfiguration?: any

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

OptionaloozieConfiguration

oozieConfiguration?: any

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

Optionalparameters

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

Parameters for linked service.

OptionalscriptActions

scriptActions?: ScriptAction[]

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.

OptionalservicePrincipalId

servicePrincipalId?: any

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

OptionalservicePrincipalKey

servicePrincipalKey?: SecretBaseUnion

The key for the service principal id.

OptionalsparkVersion

sparkVersion?: any

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

OptionalstormConfiguration

stormConfiguration?: any

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

OptionalsubnetName

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

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

Optionalversion

version?: string

Version of the linked service.

versionTypePropertiesVersion

versionTypePropertiesVersion: any

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

OptionalvirtualNetworkId

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

OptionalyarnConfiguration

yarnConfiguration?: any

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

OptionalzookeeperNodeSize

zookeeperNodeSize?: any

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

Settings

Member Visibility