你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

HDInsightOnDemandLinkedService Class

HDInsight ondemand linked service.

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

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_resource_group_auth_type: str | _models.HDInsightOndemandClusterResourceGroupAuthenticationType | 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: MutableMapping[str, Any] | 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
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

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

Default value: None
cluster_size
<xref:JSON>

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

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

Default value: None
service_principal_key
SecretBase

The key for the service principal id.

Default value: None
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_resource_group_auth_type
str or HDInsightOndemandClusterResourceGroupAuthenticationType

HDInsight On-demand cluster resource group authentication type. Known values are: "ServicePrincipalKey", "SystemAssignedManagedIdentity", and "UserAssignedManagedIdentity".

Default value: None
cluster_name_prefix
<xref:JSON>

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

Default value: None
cluster_user_name
<xref:JSON>

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

Default value: None
cluster_password
SecretBase

The password to access the cluster.

Default value: None
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).

Default value: None
cluster_ssh_password
SecretBase

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

Default value: None
additional_linked_service_names
list[LinkedServiceReference]

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

Default value: None
hcatalog_linked_service_name
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.

Default value: None
cluster_type
<xref:JSON>

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

Default value: None
spark_version
<xref:JSON>

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

Default value: None
core_configuration
<xref:JSON>

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

Default value: None
h_base_configuration
<xref:JSON>

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

Default value: None
hdfs_configuration
<xref:JSON>

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

Default value: None
hive_configuration
<xref:JSON>

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

Default value: None
map_reduce_configuration
<xref:JSON>

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

Default value: None
oozie_configuration
<xref:JSON>

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

Default value: None
storm_configuration
<xref:JSON>

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

Default value: None
yarn_configuration
<xref:JSON>

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

Default value: None
encrypted_credential
<xref:JSON>

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

Default value: None
head_node_size
<xref:JSON>

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

Default value: None
data_node_size
<xref:JSON>

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

Default value: None
zookeeper_node_size
<xref:JSON>

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

Default value: None
script_actions
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. # pylint: disable=line-too-long

Default value: None
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).

Default value: None
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).

Default value: None
credential
CredentialReference

The credential reference containing authentication information.

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Type of linked service. Required.
version
str

Version of the linked service.
connect_via
IntegrationRuntimeReference

The integration runtime reference.
description
str

Linked service description.
parameters
dict[str, ParameterSpecification]

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: string (or Expression with resultType string). 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
LinkedServiceReference

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
SecretBase

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_resource_group_auth_type
str or HDInsightOndemandClusterResourceGroupAuthenticationType

HDInsight On-demand cluster resource group authentication type. Known values are: "ServicePrincipalKey", "SystemAssignedManagedIdentity", and "UserAssignedManagedIdentity".
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
SecretBase

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
SecretBase

The password to SSH remotely connect cluster's node (for Linux).
additional_linked_service_names
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
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
<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
<xref:JSON>

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
<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
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. # 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
CredentialReference

The credential reference containing authentication information.

Methods

as_dict

Return a dict that can be serialized 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.

as_dict

Return a dict that can be serialized 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

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: Any, content_type: str | None = None) -> ModelType

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() -> None

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: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

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() -> bool

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: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

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