HDInsightOnDemandLinkedService Class

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: LinkedServiceReference, host_subscription_id: object, tenant: object, cluster_resource_group: object, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None = None, service_principal_id: object | None = None, service_principal_key: SecretBase | None = None, cluster_name_prefix: object | None = None, cluster_user_name: object | None = None, cluster_password: SecretBase | None = None, cluster_ssh_user_name: object | None = None, cluster_ssh_password: SecretBase | None = None, additional_linked_service_names: List[LinkedServiceReference] | None = None, hcatalog_linked_service_name: LinkedServiceReference | None = None, cluster_type: object | None = None, spark_version: object | None = None, core_configuration: object | None = None, h_base_configuration: object | None = None, hdfs_configuration: object | None = None, hive_configuration: object | None = None, map_reduce_configuration: object | None = None, oozie_configuration: object | None = None, storm_configuration: object | None = None, yarn_configuration: object | None = None, encrypted_credential: object | None = None, head_node_size: object | None = None, data_node_size: object | None = None, zookeeper_node_size: object | None = None, script_actions: List[ScriptAction] | None = None, virtual_network_id: object | None = None, subnet_name: object | None = None, **kwargs)

Parameters

Name	Description
additional_properties Required	dict[str, object] Unmatched properties from the message are deserialized to this collection.
type Required	str Required. Type of linked service.Constant filled by server.
connect_via Required	IntegrationRuntimeReference The integration runtime reference.
description Required	str Linked service description.
parameters Required	dict[str, ParameterSpecification] Parameters for linked service.
annotations Required	list[object] List of tags that can be used for describing the linked service.
cluster_size Required	object Required. Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
time_to_live Required	object 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 Required	object Required. Version of the HDInsight cluster.  Type: string (or Expression with resultType string).
linked_service_name Required	LinkedServiceReference Required. Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
host_subscription_id Required	object Required. The customer's subscription to host the cluster. Type: string (or Expression with resultType string).
service_principal_id Required	object The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
service_principal_key Required	SecretBase The key for the service principal id.
tenant Required	object Required. The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
cluster_resource_group Required	object Required. The resource group where the cluster belongs. Type: string (or Expression with resultType string).
cluster_name_prefix Required	object The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
cluster_user_name Required	object The username to access the cluster. Type: string (or Expression with resultType string).
cluster_password Required	SecretBase The password to access the cluster.
cluster_ssh_user_name Required	object The username to SSH remotely connect to cluster's node (for Linux). Type: string (or Expression with resultType string).
cluster_ssh_password Required	SecretBase The password to SSH remotely connect cluster's node (for Linux).
additional_linked_service_names Required	list[LinkedServiceReference] 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 Required	LinkedServiceReference 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 Required	object The cluster type. Type: string (or Expression with resultType string).
spark_version Required	object The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
core_configuration Required	object Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
h_base_configuration Required	object Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
hdfs_configuration Required	object Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
hive_configuration Required	object Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
map_reduce_configuration Required	object Specifies the MapReduce configuration parameters (mapred- site.xml) for the HDInsight cluster.
oozie_configuration Required	object Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
storm_configuration Required	object Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
yarn_configuration Required	object Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
encrypted_credential Required	object 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 Required	object Specifies the size of the head node for the HDInsight cluster.
data_node_size Required	object Specifies the size of the data node for the HDInsight cluster.
zookeeper_node_size Required	object Specifies the size of the Zoo Keeper node for the HDInsight cluster.
script_actions Required	list[ScriptAction] 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 Required	object 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 Required	object 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).

Keyword-Only Parameters

Name	Description
cluster_size Required
time_to_live Required
version Required
linked_service_name Required
host_subscription_id Required
tenant Required
cluster_resource_group Required
additional_properties Required
connect_via Required
description Required
parameters Required
annotations Required
service_principal_id Required
service_principal_key Required
cluster_name_prefix Required
cluster_user_name Required
cluster_password Required
cluster_ssh_user_name Required
cluster_ssh_password Required
additional_linked_service_names Required
hcatalog_linked_service_name Required
cluster_type Required
spark_version Required
core_configuration Required
h_base_configuration Required
hdfs_configuration Required
hive_configuration Required
map_reduce_configuration Required
oozie_configuration Required
storm_configuration Required
yarn_configuration Required
encrypted_credential Required
head_node_size Required
data_node_size Required
zookeeper_node_size Required
script_actions Required
virtual_network_id Required
subnet_name Required

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error