Feedback Edit

HDInsightOnDemandLinkedService Class

  • Reference

HDInsight ondemand linked service.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
HDInsightOnDemandLinkedService

Constructor

HDInsightOnDemandLinkedService(*, cluster_size: object, time_to_live: object, version: object, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, host_subscription_id: object, tenant: object, cluster_resource_group: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, service_principal_id: Optional[object] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, cluster_name_prefix: Optional[object] = None, cluster_user_name: Optional[object] = None, cluster_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, cluster_ssh_user_name: Optional[object] = None, cluster_ssh_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, additional_linked_service_names: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, hcatalog_linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, cluster_type: Optional[object] = None, spark_version: Optional[object] = None, core_configuration: Optional[object] = None, h_base_configuration: Optional[object] = None, hdfs_configuration: Optional[object] = None, hive_configuration: Optional[object] = None, map_reduce_configuration: Optional[object] = None, oozie_configuration: Optional[object] = None, storm_configuration: Optional[object] = None, yarn_configuration: Optional[object] = None, encrypted_credential: Optional[object] = None, head_node_size: Optional[object] = None, data_node_size: Optional[object] = None, zookeeper_node_size: Optional[object] = None, script_actions: Optional[List[azure.synapse.artifacts.models._models_py3.ScriptAction]] = None, virtual_network_id: Optional[object] = None, subnet_name: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of linked service.Constant filled by server.

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

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

cluster_size
object
Required

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

time_to_live
object
Required

Required. 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
object
Required

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

linked_service_name
LinkedServiceReference
Required

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

host_subscription_id
object
Required

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

service_principal_id
object
Required

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

service_principal_key
SecretBase
Required

The key for the service principal id.

tenant
object
Required

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

cluster_resource_group
object
Required

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

cluster_name_prefix
object
Required

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

cluster_user_name
object
Required

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

cluster_password
SecretBase
Required

The password to access the cluster.

cluster_ssh_user_name
object
Required

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

cluster_ssh_password
SecretBase
Required

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

additional_linked_service_names
list[LinkedServiceReference]
Required

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

hcatalog_linked_service_name
LinkedServiceReference
Required

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.

cluster_type
object
Required

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

spark_version
object
Required

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

core_configuration
object
Required

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

h_base_configuration
object
Required

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

hdfs_configuration
object
Required

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

hive_configuration
object
Required

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

map_reduce_configuration
object
Required

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

oozie_configuration
object
Required

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

storm_configuration
object
Required

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

yarn_configuration
object
Required

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

encrypted_credential
object
Required

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

head_node_size
object
Required

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

data_node_size
object
Required

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

zookeeper_node_size
object
Required

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

script_actions
list[ScriptAction]
Required

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.

virtual_network_id
object
Required

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

subnet_name
object
Required

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