Class HDInsightOnDemandLinkedService

HDInsight ondemand linked service.

Inheritance
System.Object
LinkedService
HDInsightOnDemandLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HDInsightOnDemandLinkedService/HDInsightOnDemandLinkedServiceConverter))]
public class HDInsightOnDemandLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

HDInsightOnDemandLinkedService(Object, Object, Object, LinkedServiceReference, Object, Object, Object)

Initializes a new instance of HDInsightOnDemandLinkedService.

Declaration
public HDInsightOnDemandLinkedService (object clusterSize, object timeToLive, object versionTypePropertiesVersion, Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference linkedServiceName, object hostSubscriptionId, object tenant, object clusterResourceGroup);
Parameters
System.Object clusterSize

Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
System.Object 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).
System.Object versionTypePropertiesVersion

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

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

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

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

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

clusterSize, timeToLive, versionTypePropertiesVersion, linkedServiceName, hostSubscriptionId, tenant or clusterResourceGroup is null.

Properties

AdditionalLinkedServiceNames

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

Declaration
public System.Collections.Generic.IList<Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference> AdditionalLinkedServiceNames { get; }
Property Value
System.Collections.Generic.IList<LinkedServiceReference>

ClusterNamePrefix

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

Declaration
public object ClusterNamePrefix { get; set; }
Property Value
System.Object

ClusterPassword

The password to access the cluster. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ClusterPassword { get; set; }
Property Value
SecretBase

ClusterResourceGroup

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

Declaration
public object ClusterResourceGroup { get; set; }
Property Value
System.Object

ClusterSize

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

Declaration
public object ClusterSize { get; set; }
Property Value
System.Object

ClusterSshPassword

The password to SSH remotely connect cluster’s node (for Linux). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ClusterSshPassword { get; set; }
Property Value
SecretBase

ClusterSshUserName

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

Declaration
public object ClusterSshUserName { get; set; }
Property Value
System.Object

ClusterType

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

Declaration
public object ClusterType { get; set; }
Property Value
System.Object

ClusterUserName

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

Declaration
public object ClusterUserName { get; set; }
Property Value
System.Object

CoreConfiguration

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

Declaration
public object CoreConfiguration { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

DataNodeSize

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

Declaration
public object DataNodeSize { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

HBaseConfiguration

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

Declaration
public object HBaseConfiguration { get; set; }
Property Value
System.Object

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.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference HcatalogLinkedServiceName { get; set; }
Property Value
LinkedServiceReference

HdfsConfiguration

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

Declaration
public object HdfsConfiguration { get; set; }
Property Value
System.Object

HeadNodeSize

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

Declaration
public object HeadNodeSize { get; set; }
Property Value
System.Object

HiveConfiguration

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

Declaration
public object HiveConfiguration { get; set; }
Property Value
System.Object

HostSubscriptionId

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

Declaration
public object HostSubscriptionId { get; set; }
Property Value
System.Object

LinkedServiceName

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

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference LinkedServiceName { get; set; }
Property Value
LinkedServiceReference

MapReduceConfiguration

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

Declaration
public object MapReduceConfiguration { get; set; }
Property Value
System.Object

OozieConfiguration

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

Declaration
public object OozieConfiguration { get; set; }
Property Value
System.Object

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.

Declaration
public System.Collections.Generic.IList<Azure.Analytics.Synapse.Artifacts.Models.ScriptAction> ScriptActions { get; }
Property Value
System.Collections.Generic.IList<ScriptAction>

ServicePrincipalId

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

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

ServicePrincipalKey

The key for the service principal id. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }
Property Value
SecretBase

SparkVersion

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

Declaration
public object SparkVersion { get; set; }
Property Value
System.Object

StormConfiguration

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

Declaration
public object StormConfiguration { get; set; }
Property Value
System.Object

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

Declaration
public object SubnetName { get; set; }
Property Value
System.Object

Tenant

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

Declaration
public object Tenant { get; set; }
Property Value
System.Object

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

Declaration
public object TimeToLive { get; set; }
Property Value
System.Object

VersionTypePropertiesVersion

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

Declaration
public object VersionTypePropertiesVersion { get; set; }
Property Value
System.Object

VirtualNetworkId

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

Declaration
public object VirtualNetworkId { get; set; }
Property Value
System.Object

YarnConfiguration

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

Declaration
public object YarnConfiguration { get; set; }
Property Value
System.Object

ZookeeperNodeSize

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

Declaration
public object ZookeeperNodeSize { get; set; }
Property Value
System.Object