Share via


HDInsightOnDemandLinkedService Class

Definition

HDInsight ondemand linked service.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("HDInsightOnDemand")]
public class HDInsightOnDemandLinkedService : Microsoft.Azure.Management.DataFactory.Models.LinkedService
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("HDInsightOnDemand")>]
type HDInsightOnDemandLinkedService = class
    inherit LinkedService
Public Class HDInsightOnDemandLinkedService
Inherits LinkedService
Inheritance
HDInsightOnDemandLinkedService
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

HDInsightOnDemandLinkedService()

Initializes a new instance of the HDInsightOnDemandLinkedService class.

HDInsightOnDemandLinkedService(Object, Object, Object, LinkedServiceReference, Object, Object, Object, IDictionary<String,Object>, IntegrationRuntimeReference, String, IDictionary<String,ParameterSpecification>, IList<Object>, Object, SecretBase, Object, Object, SecretBase, Object, SecretBase, IList<LinkedServiceReference>, LinkedServiceReference, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, IList<ScriptAction>, Object, Object, CredentialReference)

Initializes a new instance of the HDInsightOnDemandLinkedService class.

Properties

AdditionalLinkedServiceNames

Gets or sets specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from LinkedService)
Annotations

Gets or sets list of tags that can be used for describing the linked service.

(Inherited from LinkedService)
ClusterNamePrefix

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

ClusterPassword

Gets or sets the password to access the cluster.

ClusterResourceGroup

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

ClusterSize

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

ClusterSshPassword

Gets or sets the password to SSH remotely connect cluster’s node (for Linux).

ClusterSshUserName

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

ClusterType

Gets or sets the cluster type. Type: string (or Expression with resultType string).

ClusterUserName

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

ConnectVia

Gets or sets the integration runtime reference.

(Inherited from LinkedService)
CoreConfiguration

Gets or sets specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.

Credential

Gets or sets the credential reference containing authentication information.

DataNodeSize

Gets or sets specifies the size of the data node for the HDInsight cluster.

Description

Gets or sets linked service description.

(Inherited from LinkedService)
EncryptedCredential

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

HBaseConfiguration

Gets or sets specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.

HcatalogLinkedServiceName

Gets or sets 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

Gets or sets specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.

HeadNodeSize

Gets or sets specifies the size of the head node for the HDInsight cluster.

HiveConfiguration

Gets or sets specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.

HostSubscriptionId

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

LinkedServiceName

Gets or sets azure Storage linked service to be used by the on-demand cluster for storing and processing data.

MapReduceConfiguration

Gets or sets specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.

OozieConfiguration

Gets or sets specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.

Parameters

Gets or sets parameters for linked service.

(Inherited from LinkedService)
ScriptActions

Gets or sets 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&amp;bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.

ServicePrincipalId

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

ServicePrincipalKey

Gets or sets the key for the service principal id.

SparkVersion

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

StormConfiguration

Gets or sets specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.

SubnetName

Gets or sets 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

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

TimeToLive

Gets or sets 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).

Version

Gets or sets version of the HDInsight cluster.  Type: string (or Expression with resultType string).

VirtualNetworkId

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

YarnConfiguration

Gets or sets specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.

ZookeeperNodeSize

Gets or sets specifies the size of the Zoo Keeper node for the HDInsight cluster.

Methods

Validate()

Validate the object.

Applies to