HDInsightOnDemandLinkedService Class
- java.
lang. Object - com.
azure. resourcemanager. datafactory. models. LinkedService - com.
azure. resourcemanager. datafactory. models. HDInsightOnDemandLinkedService
- com.
- com.
public final class HDInsightOnDemandLinkedService
extends LinkedService
HDInsight ondemand linked service.
Constructor Summary
| Constructor | Description |
|---|---|
| HDInsightOnDemandLinkedService() |
Creates an instance of HDInsight |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
List<Linked |
additionalLinkedServiceNames()
Get the additional |
| Object |
clusterNamePrefix()
Get the cluster |
|
Secret |
clusterPassword()
Get the cluster |
| Object |
clusterResourceGroup()
Get the cluster |
| Object |
clusterSize()
Get the cluster |
|
Secret |
clusterSshPassword()
Get the cluster |
| Object |
clusterSshUsername()
Get the cluster |
| Object |
clusterType()
Get the cluster |
| Object |
clusterUsername()
Get the cluster |
| Object |
coreConfiguration()
Get the core |
|
Credential |
credential()
Get the credential property: The credential reference containing authentication information. |
| Object |
dataNodeSize()
Get the data |
| String |
encryptedCredential()
Get the encrypted |
| Object |
hBaseConfiguration()
Get the h |
|
Linked |
hcatalogLinkedServiceName()
Get the hcatalog |
| Object |
hdfsConfiguration()
Get the hdfs |
| Object |
headNodeSize()
Get the head |
| Object |
hiveConfiguration()
Get the hive |
| Object |
hostSubscriptionId()
Get the host |
|
Linked |
linkedServiceName()
Get the linked |
| Object |
mapReduceConfiguration()
Get the map |
| Object |
oozieConfiguration()
Get the oozie |
|
List<Script |
scriptActions()
Get the script |
| Object |
servicePrincipalId()
Get the service |
|
Secret |
servicePrincipalKey()
Get the service |
| Object |
sparkVersion()
Get the spark |
| Object |
stormConfiguration()
Get the storm |
| Object |
subnetName()
Get the subnet |
| Object |
tenant()
Get the tenant property: The Tenant id/name to which the service principal belongs. |
| Object |
timeToLive()
Get the time |
| void |
validate()
Validates the instance. |
| Object |
version()
Get the version property: Version of the HDInsight cluster. Type: string (or Expression with result |
| Object |
virtualNetworkId()
Get the virtual |
|
HDInsight |
withAdditionalLinkedServiceNames(List<LinkedServiceReference> additionalLinkedServiceNames)
Set the additional |
|
HDInsight |
withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service. |
|
HDInsight |
withClusterNamePrefix(Object clusterNamePrefix)
Set the cluster |
|
HDInsight |
withClusterPassword(SecretBase clusterPassword)
Set the cluster |
|
HDInsight |
withClusterResourceGroup(Object clusterResourceGroup)
Set the cluster |
|
HDInsight |
withClusterSize(Object clusterSize)
Set the cluster |
|
HDInsight |
withClusterSshPassword(SecretBase clusterSshPassword)
Set the cluster |
|
HDInsight |
withClusterSshUsername(Object clusterSshUsername)
Set the cluster |
|
HDInsight |
withClusterType(Object clusterType)
Set the cluster |
|
HDInsight |
withClusterUsername(Object clusterUsername)
Set the cluster |
|
HDInsight |
withConnectVia(IntegrationRuntimeReference connectVia)
Set the connect |
|
HDInsight |
withCoreConfiguration(Object coreConfiguration)
Set the core |
|
HDInsight |
withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
HDInsight |
withDataNodeSize(Object dataNodeSize)
Set the data |
|
HDInsight |
withDescription(String description)
Set the description property: Linked service description. |
|
HDInsight |
withEncryptedCredential(String encryptedCredential)
Set the encrypted |
|
HDInsight |
withHBaseConfiguration(Object hBaseConfiguration)
Set the h |
|
HDInsight |
withHcatalogLinkedServiceName(LinkedServiceReference hcatalogLinkedServiceName)
Set the hcatalog |
|
HDInsight |
withHdfsConfiguration(Object hdfsConfiguration)
Set the hdfs |
|
HDInsight |
withHeadNodeSize(Object headNodeSize)
Set the head |
|
HDInsight |
withHiveConfiguration(Object hiveConfiguration)
Set the hive |
|
HDInsight |
withHostSubscriptionId(Object hostSubscriptionId)
Set the host |
|
HDInsight |
withLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linked |
|
HDInsight |
withMapReduceConfiguration(Object mapReduceConfiguration)
Set the map |
|
HDInsight |
withOozieConfiguration(Object oozieConfiguration)
Set the oozie |
|
HDInsight |
withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service. |
|
HDInsight |
withScriptActions(List<ScriptAction> scriptActions)
Set the script |
|
HDInsight |
withServicePrincipalId(Object servicePrincipalId)
Set the service |
|
HDInsight |
withServicePrincipalKey(SecretBase servicePrincipalKey)
Set the service |
|
HDInsight |
withSparkVersion(Object sparkVersion)
Set the spark |
|
HDInsight |
withStormConfiguration(Object stormConfiguration)
Set the storm |
|
HDInsight |
withSubnetName(Object subnetName)
Set the subnet |
|
HDInsight |
withTenant(Object tenant)
Set the tenant property: The Tenant id/name to which the service principal belongs. |
|
HDInsight |
withTimeToLive(Object timeToLive)
Set the time |
|
HDInsight |
withVersion(Object version)
Set the version property: Version of the HDInsight cluster. Type: string (or Expression with result |
|
HDInsight |
withVirtualNetworkId(Object virtualNetworkId)
Set the virtual |
|
HDInsight |
withYarnConfiguration(Object yarnConfiguration)
Set the yarn |
|
HDInsight |
withZookeeperNodeSize(Object zookeeperNodeSize)
Set the zookeeper |
| Object |
yarnConfiguration()
Get the yarn |
| Object |
zookeeperNodeSize()
Get the zookeeper |
Methods inherited from LinkedService
Methods inherited from java.lang.Object
Constructor Details
HDInsightOnDemandLinkedService
public HDInsightOnDemandLinkedService()
Creates an instance of HDInsightOnDemandLinkedService class.
Method Details
additionalLinkedServiceNames
public List
Get the additionalLinkedServiceNames property: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
Returns:
clusterNamePrefix
public Object clusterNamePrefix()
Get the clusterNamePrefix property: The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
Returns:
clusterPassword
public SecretBase clusterPassword()
Get the clusterPassword property: The password to access the cluster.
Returns:
clusterResourceGroup
public Object clusterResourceGroup()
Get the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
Returns:
clusterSize
public Object clusterSize()
Get the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).
Returns:
clusterSshPassword
public SecretBase clusterSshPassword()
Get the clusterSshPassword property: The password to SSH remotely connect cluster\u2019s node (for Linux).
Returns:
clusterSshUsername
public Object clusterSshUsername()
Get the clusterSshUsername property: The username to SSH remotely connect to cluster\u2019s node (for Linux). Type: string (or Expression with resultType string).
Returns:
clusterType
public Object clusterType()
Get the clusterType property: The cluster type. Type: string (or Expression with resultType string).
Returns:
clusterUsername
public Object clusterUsername()
Get the clusterUsername property: The username to access the cluster. Type: string (or Expression with resultType string).
Returns:
coreConfiguration
public Object coreConfiguration()
Get the coreConfiguration property: Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
Returns:
credential
public CredentialReference credential()
Get the credential property: The credential reference containing authentication information.
Returns:
dataNodeSize
public Object dataNodeSize()
Get the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
Returns:
encryptedCredential
public String encryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
Returns:
hBaseConfiguration
public Object hBaseConfiguration()
Get the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
Returns:
hcatalogLinkedServiceName
public LinkedServiceReference hcatalogLinkedServiceName()
Get the hcatalogLinkedServiceName property: 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.
Returns:
hdfsConfiguration
public Object hdfsConfiguration()
Get the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
Returns:
headNodeSize
public Object headNodeSize()
Get the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
Returns:
hiveConfiguration
public Object hiveConfiguration()
Get the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
Returns:
hostSubscriptionId
public Object hostSubscriptionId()
Get the hostSubscriptionId property: The customer\u2019s subscription to host the cluster. Type: string (or Expression with resultType string).
Returns:
linkedServiceName
public LinkedServiceReference linkedServiceName()
Get the linkedServiceName property: Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
Returns:
mapReduceConfiguration
public Object mapReduceConfiguration()
Get the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
Returns:
oozieConfiguration
public Object oozieConfiguration()
Get the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
Returns:
scriptActions
public List
Get the scriptActions property: 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.
Returns:
servicePrincipalId
public Object servicePrincipalId()
Get the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
Returns:
servicePrincipalKey
public SecretBase servicePrincipalKey()
Get the servicePrincipalKey property: The key for the service principal id.
Returns:
sparkVersion
public Object sparkVersion()
Get the sparkVersion property: The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
Returns:
stormConfiguration
public Object stormConfiguration()
Get the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
Returns:
subnetName
public Object subnetName()
Get the subnetName property: 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).
Returns:
tenant
public Object tenant()
Get the tenant property: The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
Returns:
timeToLive
public Object timeToLive()
Get the timeToLive property: 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).
Returns:
validate
public void validate()
Validates the instance.
Overrides:
HDInsightOnDemandLinkedService.validate()version
public Object version()
Get the version property: Version of the HDInsight cluster. Type: string (or Expression with resultType string).
Returns:
virtualNetworkId
public Object virtualNetworkId()
Get the virtualNetworkId property: The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
Returns:
withAdditionalLinkedServiceNames
public HDInsightOnDemandLinkedService withAdditionalLinkedServiceNames(List
Set the additionalLinkedServiceNames property: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
Parameters:
Returns:
withAnnotations
public HDInsightOnDemandLinkedService withAnnotations(List
Set the annotations property: List of tags that can be used for describing the linked service.
Overrides:
HDInsightOnDemandLinkedService.withAnnotations(List<Object> annotations)Parameters:
withClusterNamePrefix
public HDInsightOnDemandLinkedService withClusterNamePrefix(Object clusterNamePrefix)
Set the clusterNamePrefix property: The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
Parameters:
Returns:
withClusterPassword
public HDInsightOnDemandLinkedService withClusterPassword(SecretBase clusterPassword)
Set the clusterPassword property: The password to access the cluster.
Parameters:
Returns:
withClusterResourceGroup
public HDInsightOnDemandLinkedService withClusterResourceGroup(Object clusterResourceGroup)
Set the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
Parameters:
Returns:
withClusterSize
public HDInsightOnDemandLinkedService withClusterSize(Object clusterSize)
Set the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).
Parameters:
Returns:
withClusterSshPassword
public HDInsightOnDemandLinkedService withClusterSshPassword(SecretBase clusterSshPassword)
Set the clusterSshPassword property: The password to SSH remotely connect cluster\u2019s node (for Linux).
Parameters:
Returns:
withClusterSshUsername
public HDInsightOnDemandLinkedService withClusterSshUsername(Object clusterSshUsername)
Set the clusterSshUsername property: The username to SSH remotely connect to cluster\u2019s node (for Linux). Type: string (or Expression with resultType string).
Parameters:
Returns:
withClusterType
public HDInsightOnDemandLinkedService withClusterType(Object clusterType)
Set the clusterType property: The cluster type. Type: string (or Expression with resultType string).
Parameters:
Returns:
withClusterUsername
public HDInsightOnDemandLinkedService withClusterUsername(Object clusterUsername)
Set the clusterUsername property: The username to access the cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
withConnectVia
public HDInsightOnDemandLinkedService withConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.
Overrides:
HDInsightOnDemandLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)Parameters:
withCoreConfiguration
public HDInsightOnDemandLinkedService withCoreConfiguration(Object coreConfiguration)
Set the coreConfiguration property: Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
Parameters:
Returns:
withCredential
public HDInsightOnDemandLinkedService withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
withDataNodeSize
public HDInsightOnDemandLinkedService withDataNodeSize(Object dataNodeSize)
Set the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
Parameters:
Returns:
withDescription
public HDInsightOnDemandLinkedService withDescription(String description)
Set the description property: Linked service description.
Overrides:
HDInsightOnDemandLinkedService.withDescription(String description)Parameters:
withEncryptedCredential
public HDInsightOnDemandLinkedService withEncryptedCredential(String encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
Parameters:
Returns:
withHBaseConfiguration
public HDInsightOnDemandLinkedService withHBaseConfiguration(Object hBaseConfiguration)
Set the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withHcatalogLinkedServiceName
public HDInsightOnDemandLinkedService withHcatalogLinkedServiceName(LinkedServiceReference hcatalogLinkedServiceName)
Set the hcatalogLinkedServiceName property: 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.
Parameters:
Returns:
withHdfsConfiguration
public HDInsightOnDemandLinkedService withHdfsConfiguration(Object hdfsConfiguration)
Set the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withHeadNodeSize
public HDInsightOnDemandLinkedService withHeadNodeSize(Object headNodeSize)
Set the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
Parameters:
Returns:
withHiveConfiguration
public HDInsightOnDemandLinkedService withHiveConfiguration(Object hiveConfiguration)
Set the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withHostSubscriptionId
public HDInsightOnDemandLinkedService withHostSubscriptionId(Object hostSubscriptionId)
Set the hostSubscriptionId property: The customer\u2019s subscription to host the cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
withLinkedServiceName
public HDInsightOnDemandLinkedService withLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
Parameters:
Returns:
withMapReduceConfiguration
public HDInsightOnDemandLinkedService withMapReduceConfiguration(Object mapReduceConfiguration)
Set the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withOozieConfiguration
public HDInsightOnDemandLinkedService withOozieConfiguration(Object oozieConfiguration)
Set the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withParameters
public HDInsightOnDemandLinkedService withParameters(Map
Set the parameters property: Parameters for linked service.
Overrides:
HDInsightOnDemandLinkedService.withParameters(Map<String,ParameterSpecification> parameters)Parameters:
withScriptActions
public HDInsightOnDemandLinkedService withScriptActions(List
Set the scriptActions property: 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.
Parameters:
Returns:
withServicePrincipalId
public HDInsightOnDemandLinkedService withServicePrincipalId(Object servicePrincipalId)
Set the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
Parameters:
Returns:
withServicePrincipalKey
public HDInsightOnDemandLinkedService withServicePrincipalKey(SecretBase servicePrincipalKey)
Set the servicePrincipalKey property: The key for the service principal id.
Parameters:
Returns:
withSparkVersion
public HDInsightOnDemandLinkedService withSparkVersion(Object sparkVersion)
Set the sparkVersion property: The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
Parameters:
Returns:
withStormConfiguration
public HDInsightOnDemandLinkedService withStormConfiguration(Object stormConfiguration)
Set the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withSubnetName
public HDInsightOnDemandLinkedService withSubnetName(Object subnetName)
Set the subnetName property: 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).
Parameters:
Returns:
withTenant
public HDInsightOnDemandLinkedService withTenant(Object tenant)
Set the tenant property: The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
Parameters:
Returns:
withTimeToLive
public HDInsightOnDemandLinkedService withTimeToLive(Object timeToLive)
Set the timeToLive property: 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).
Parameters:
Returns:
withVersion
public HDInsightOnDemandLinkedService withVersion(Object version)
Set the version property: Version of the HDInsight cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
withVirtualNetworkId
public HDInsightOnDemandLinkedService withVirtualNetworkId(Object virtualNetworkId)
Set the virtualNetworkId property: The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
Parameters:
Returns:
withYarnConfiguration
public HDInsightOnDemandLinkedService withYarnConfiguration(Object yarnConfiguration)
Set the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
Parameters:
Returns:
withZookeeperNodeSize
public HDInsightOnDemandLinkedService withZookeeperNodeSize(Object zookeeperNodeSize)
Set the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
Parameters:
Returns:
yarnConfiguration
public Object yarnConfiguration()
Get the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
Returns:
zookeeperNodeSize
public Object zookeeperNodeSize()
Get the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for