HDInsightOnDemandLinkedService Class
HDInsight ondemand linked service.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.mgmt.datafactory.models._models_py3.LinkedServiceHDInsightOnDemandLinkedService
Constructor
HDInsightOnDemandLinkedService(*, cluster_size: MutableMapping[str, Any], time_to_live: MutableMapping[str, Any], version_type_properties_version: MutableMapping[str, Any], linked_service_name: _models.LinkedServiceReference, host_subscription_id: MutableMapping[str, Any], tenant: MutableMapping[str, Any], cluster_resource_group: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase | None = None, cluster_name_prefix: MutableMapping[str, Any] | None = None, cluster_user_name: MutableMapping[str, Any] | None = None, cluster_password: _models.SecretBase | None = None, cluster_ssh_user_name: MutableMapping[str, Any] | None = None, cluster_ssh_password: _models.SecretBase | None = None, additional_linked_service_names: List[_models.LinkedServiceReference] | None = None, hcatalog_linked_service_name: _models.LinkedServiceReference | None = None, cluster_type: MutableMapping[str, Any] | None = None, spark_version: MutableMapping[str, Any] | None = None, core_configuration: MutableMapping[str, Any] | None = None, h_base_configuration: MutableMapping[str, Any] | None = None, hdfs_configuration: MutableMapping[str, Any] | None = None, hive_configuration: MutableMapping[str, Any] | None = None, map_reduce_configuration: MutableMapping[str, Any] | None = None, oozie_configuration: MutableMapping[str, Any] | None = None, storm_configuration: MutableMapping[str, Any] | None = None, yarn_configuration: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, head_node_size: MutableMapping[str, Any] | None = None, data_node_size: MutableMapping[str, Any] | None = None, zookeeper_node_size: MutableMapping[str, Any] | None = None, script_actions: List[_models.ScriptAction] | None = None, virtual_network_id: MutableMapping[str, Any] | None = None, subnet_name: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
cluster_size
|
<xref:JSON>
Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). Required. |
|
time_to_live
|
<xref:JSON>
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). Required. |
|
version_type_properties_version
|
<xref:JSON>
Version of the HDInsight cluster. Type: string (or Expression with resultType string). Required. |
|
linked_service_name
|
Azure Storage linked service to be used by the on-demand cluster for storing and processing data. Required. |
|
host_subscription_id
|
<xref:JSON>
The customer's subscription to host the cluster. Type: string (or Expression with resultType string). Required. |
|
service_principal_id
|
<xref:JSON>
The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). |
|
service_principal_key
|
The key for the service principal id. |
|
tenant
|
<xref:JSON>
The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). Required. |
|
cluster_resource_group
|
<xref:JSON>
The resource group where the cluster belongs. Type: string (or Expression with resultType string). Required. |
|
cluster_name_prefix
|
<xref:JSON>
The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). |
|
cluster_user_name
|
<xref:JSON>
The username to access the cluster. Type: string (or Expression with resultType string). |
|
cluster_password
|
The password to access the cluster. |
|
cluster_ssh_user_name
|
<xref:JSON>
The username to SSH remotely connect to cluster's node (for Linux). Type: string (or Expression with resultType string). |
|
cluster_ssh_password
|
The password to SSH remotely connect cluster's node (for Linux). |
|
additional_linked_service_names
|
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
|
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
|
<xref:JSON>
The cluster type. Type: string (or Expression with resultType string). |
|
spark_version
|
<xref:JSON>
The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). |
|
core_configuration
|
<xref:JSON>
Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. |
|
h_base_configuration
|
<xref:JSON>
Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. |
|
hdfs_configuration
|
<xref:JSON>
Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. |
|
hive_configuration
|
<xref:JSON>
Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. |
|
map_reduce_configuration
|
<xref:JSON>
Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. |
|
oozie_configuration
|
<xref:JSON>
Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. |
|
storm_configuration
|
<xref:JSON>
Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. |
|
yarn_configuration
|
<xref:JSON>
Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
|
head_node_size
|
<xref:JSON>
Specifies the size of the head node for the HDInsight cluster. |
|
data_node_size
|
<xref:JSON>
Specifies the size of the data node for the HDInsight cluster. |
|
zookeeper_node_size
|
<xref:JSON>
Specifies the size of the Zoo Keeper node for the HDInsight cluster. |
|
script_actions
|
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. # pylint: disable=line-too-long |
|
virtual_network_id
|
<xref:JSON>
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
|
<xref:JSON>
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). |
|
credential
|
The credential reference containing authentication information. |
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
cluster_size
|
<xref:JSON>
Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). Required. |
|
time_to_live
|
<xref:JSON>
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). Required. |
|
version_type_properties_version
|
<xref:JSON>
Version of the HDInsight cluster. Type: string (or Expression with resultType string). Required. |
|
linked_service_name
|
Azure Storage linked service to be used by the on-demand cluster for storing and processing data. Required. |
|
host_subscription_id
|
<xref:JSON>
The customer's subscription to host the cluster. Type: string (or Expression with resultType string). Required. |
|
service_principal_id
|
<xref:JSON>
The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). |
|
service_principal_key
|
The key for the service principal id. |
|
tenant
|
<xref:JSON>
The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). Required. |
|
cluster_resource_group
|
<xref:JSON>
The resource group where the cluster belongs. Type: string (or Expression with resultType string). Required. |
|
cluster_name_prefix
|
<xref:JSON>
The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). |
|
cluster_user_name
|
<xref:JSON>
The username to access the cluster. Type: string (or Expression with resultType string). |
|
cluster_password
|
The password to access the cluster. |
|
cluster_ssh_user_name
|
<xref:JSON>
The username to SSH remotely connect to cluster's node (for Linux). Type: string (or Expression with resultType string). |
|
cluster_ssh_password
|
The password to SSH remotely connect cluster's node (for Linux). |
|
additional_linked_service_names
|
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
|
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
|
<xref:JSON>
The cluster type. Type: string (or Expression with resultType string). |
|
spark_version
|
<xref:JSON>
The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). |
|
core_configuration
|
<xref:JSON>
Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. |
|
h_base_configuration
|
<xref:JSON>
Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. |
|
hdfs_configuration
|
<xref:JSON>
Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. |
|
hive_configuration
|
<xref:JSON>
Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. |
|
map_reduce_configuration
|
<xref:JSON>
Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. |
|
oozie_configuration
|
<xref:JSON>
Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. |
|
storm_configuration
|
<xref:JSON>
Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. |
|
yarn_configuration
|
<xref:JSON>
Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
|
head_node_size
|
<xref:JSON>
Specifies the size of the head node for the HDInsight cluster. |
|
data_node_size
|
<xref:JSON>
Specifies the size of the data node for the HDInsight cluster. |
|
zookeeper_node_size
|
<xref:JSON>
Specifies the size of the Zoo Keeper node for the HDInsight cluster. |
|
script_actions
|
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. # pylint: disable=line-too-long |
|
virtual_network_id
|
<xref:JSON>
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
|
<xref:JSON>
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). |
|
credential
|
The credential reference containing authentication information. |
Azure SDK for Python