HDInsightOnDemandLinkedService Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

HDInsightOnDemandLinkedService.cs

HDInsight ondemand linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HDInsightOnDemandLinkedService+HDInsightOnDemandLinkedServiceConverter))]
public class HDInsightOnDemandLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HDInsightOnDemandLinkedService+HDInsightOnDemandLinkedServiceConverter))>]
type HDInsightOnDemandLinkedService = class
    inherit LinkedService

Public Class HDInsightOnDemandLinkedService
Inherits LinkedService

Inheritance

Object

LinkedService

HDInsightOnDemandLinkedService

Attributes

JsonConverterAttribute

Constructors

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

Initializes a new instance of HDInsightOnDemandLinkedService.

Properties

AdditionalLinkedServiceNames	Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
AdditionalProperties	Additional Properties. (Inherited from LinkedService)
Annotations	List of tags that can be used for describing the linked service. (Inherited from LinkedService)
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. 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.
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: string (or Expression with resultType string).
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.
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).
ConnectVia	The integration runtime reference. (Inherited from LinkedService)
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.
Description	Linked service description. (Inherited from LinkedService)
EncryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType 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.
Parameters	Parameters for linked service. (Inherited from LinkedService)
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. 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.
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).
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.