HDInsightOnDemandLinkedService Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

HDInsightOnDemandLinkedService.cs

HDInsight ondemand linked service.

public class HDInsightOnDemandLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.HDInsightOnDemandLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.HDInsightOnDemandLinkedService>

type HDInsightOnDemandLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<HDInsightOnDemandLinkedService>
    interface IPersistableModel<HDInsightOnDemandLinkedService>

Public Class HDInsightOnDemandLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of HDInsightOnDemandLinkedService), IPersistableModel(Of HDInsightOnDemandLinkedService)

Inheritance

Object

DataFactoryLinkedServiceProperties

HDInsightOnDemandLinkedService

Implements

IJsonModel<HDInsightOnDemandLinkedService> IPersistableModel<HDInsightOnDemandLinkedService> IPersistableModel<T>

Constructors

HDInsightOnDemandLinkedService(DataFactoryElement<Int32>, DataFactoryElement<String>, DataFactoryElement<String>, DataFactoryLinkedServiceReference, DataFactoryElement<String>, DataFactoryElement<String>, DataFactoryElement<String>)

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 To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryLinkedServiceProperties)
Annotations	List of tags that can be used for describing the linked service. To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryLinkedServiceProperties)
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.
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: int (or Expression with resultType int).
ClusterSshPassword	The password to SSH remotely connect cluster’s node (for Linux).
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 DataFactoryLinkedServiceProperties)
CoreConfiguration	Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Credential	The credential reference containing authentication information.
DataNodeSize	Specifies the size of the data node for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Description	Linked service description. (Inherited from DataFactoryLinkedServiceProperties)
EncryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
HBaseConfiguration	Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
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. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
HeadNodeSize	Specifies the size of the head node for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
HiveConfiguration	Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
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.
LinkedServiceVersion	Version of the linked service. (Inherited from DataFactoryLinkedServiceProperties)
MapReduceConfiguration	Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
OozieConfiguration	Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Parameters	Parameters for linked service. (Inherited from DataFactoryLinkedServiceProperties)
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.
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. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
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).
TimeToLiveExpression	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. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
ZookeeperNodeSize	Specifies the size of the Zoo Keeper node for the HDInsight cluster. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<HDInsightOnDemandLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<HDInsightOnDemandLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<HDInsightOnDemandLinkedService>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<HDInsightOnDemandLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<HDInsightOnDemandLinkedService>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.