HDInsightOnDemandLinkedService Class
- java.
lang. Object - com.
azure. analytics. synapse. artifacts. models. LinkedService - com.
azure. analytics. synapse. artifacts. models. HDInsightOnDemandLinkedService
- com.
- com.
public 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 |
getAdditionalLinkedServiceNames()
Get the additional |
| Object |
getClusterNamePrefix()
Get the cluster |
|
Secret |
getClusterPassword()
Get the cluster |
| Object |
getClusterResourceGroup()
Get the cluster |
| Object |
getClusterSize()
Get the cluster |
|
Secret |
getClusterSshPassword()
Get the cluster |
| Object |
getClusterSshUserName()
Get the cluster |
| Object |
getClusterType()
Get the cluster |
| Object |
getClusterUserName()
Get the cluster |
| Object |
getCoreConfiguration()
Get the core |
|
Credential |
getCredential()
Get the credential property: The credential reference containing authentication information. |
| Object |
getDataNodeSize()
Get the data |
| Object |
getEncryptedCredential()
Get the encrypted |
| Object |
getHBaseConfiguration()
Get the h |
|
Linked |
getHcatalogLinkedServiceName()
Get the hcatalog |
| Object |
getHdfsConfiguration()
Get the hdfs |
| Object |
getHeadNodeSize()
Get the head |
| Object |
getHiveConfiguration()
Get the hive |
| Object |
getHostSubscriptionId()
Get the host |
|
Linked |
getLinkedServiceName()
Get the linked |
| Object |
getMapReduceConfiguration()
Get the map |
| Object |
getOozieConfiguration()
Get the oozie |
|
List<Script |
getScriptActions()
Get the script |
| Object |
getServicePrincipalId()
Get the service |
|
Secret |
getServicePrincipalKey()
Get the service |
| Object |
getSparkVersion()
Get the spark |
| Object |
getStormConfiguration()
Get the storm |
| Object |
getSubnetName()
Get the subnet |
| Object |
getTenant()
Get the tenant property: The Tenant id/name to which the service principal belongs. |
| Object |
getTimeToLive()
Get the time |
| Object |
getVersion()
Get the version property: Version of the HDInsight cluster. Type: string (or Expression with result |
| Object |
getVirtualNetworkId()
Get the virtual |
| Object |
getYarnConfiguration()
Get the yarn |
| Object |
getZookeeperNodeSize()
Get the zookeeper |
|
HDInsight |
setAdditionalLinkedServiceNames(List<LinkedServiceReference> additionalLinkedServiceNames)
Set the additional |
|
HDInsight |
setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service. |
|
HDInsight |
setClusterNamePrefix(Object clusterNamePrefix)
Set the cluster |
|
HDInsight |
setClusterPassword(SecretBase clusterPassword)
Set the cluster |
|
HDInsight |
setClusterResourceGroup(Object clusterResourceGroup)
Set the cluster |
|
HDInsight |
setClusterSize(Object clusterSize)
Set the cluster |
|
HDInsight |
setClusterSshPassword(SecretBase clusterSshPassword)
Set the cluster |
|
HDInsight |
setClusterSshUserName(Object clusterSshUserName)
Set the cluster |
|
HDInsight |
setClusterType(Object clusterType)
Set the cluster |
|
HDInsight |
setClusterUserName(Object clusterUserName)
Set the cluster |
|
HDInsight |
setConnectVia(IntegrationRuntimeReference connectVia)
Set the connect |
|
HDInsight |
setCoreConfiguration(Object coreConfiguration)
Set the core |
|
HDInsight |
setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
HDInsight |
setDataNodeSize(Object dataNodeSize)
Set the data |
|
HDInsight |
setDescription(String description)
Set the description property: Linked service description. |
|
HDInsight |
setEncryptedCredential(Object encryptedCredential)
Set the encrypted |
|
HDInsight |
setHBaseConfiguration(Object hBaseConfiguration)
Set the h |
|
HDInsight |
setHcatalogLinkedServiceName(LinkedServiceReference hcatalogLinkedServiceName)
Set the hcatalog |
|
HDInsight |
setHdfsConfiguration(Object hdfsConfiguration)
Set the hdfs |
|
HDInsight |
setHeadNodeSize(Object headNodeSize)
Set the head |
|
HDInsight |
setHiveConfiguration(Object hiveConfiguration)
Set the hive |
|
HDInsight |
setHostSubscriptionId(Object hostSubscriptionId)
Set the host |
|
HDInsight |
setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linked |
|
HDInsight |
setMapReduceConfiguration(Object mapReduceConfiguration)
Set the map |
|
HDInsight |
setOozieConfiguration(Object oozieConfiguration)
Set the oozie |
|
HDInsight |
setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service. |
|
HDInsight |
setScriptActions(List<ScriptAction> scriptActions)
Set the script |
|
HDInsight |
setServicePrincipalId(Object servicePrincipalId)
Set the service |
|
HDInsight |
setServicePrincipalKey(SecretBase servicePrincipalKey)
Set the service |
|
HDInsight |
setSparkVersion(Object sparkVersion)
Set the spark |
|
HDInsight |
setStormConfiguration(Object stormConfiguration)
Set the storm |
|
HDInsight |
setSubnetName(Object subnetName)
Set the subnet |
|
HDInsight |
setTenant(Object tenant)
Set the tenant property: The Tenant id/name to which the service principal belongs. |
|
HDInsight |
setTimeToLive(Object timeToLive)
Set the time |
|
HDInsight |
setVersion(Object version)
Set the version property: Version of the HDInsight cluster. Type: string (or Expression with result |
|
HDInsight |
setVirtualNetworkId(Object virtualNetworkId)
Set the virtual |
|
HDInsight |
setYarnConfiguration(Object yarnConfiguration)
Set the yarn |
|
HDInsight |
setZookeeperNodeSize(Object zookeeperNodeSize)
Set 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
getAdditionalLinkedServiceNames
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:
getClusterNamePrefix
public Object getClusterNamePrefix()
Get the clusterNamePrefix property: The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
Returns:
getClusterPassword
public SecretBase getClusterPassword()
Get the clusterPassword property: The password to access the cluster.
Returns:
getClusterResourceGroup
public Object getClusterResourceGroup()
Get the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
Returns:
getClusterSize
public Object getClusterSize()
Get the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
Returns:
getClusterSshPassword
public SecretBase getClusterSshPassword()
Get the clusterSshPassword property: The password to SSH remotely connect cluster\u2019s node (for Linux).
Returns:
getClusterSshUserName
public Object getClusterSshUserName()
Get the clusterSshUserName property: The username to SSH remotely connect to cluster\u2019s node (for Linux). Type: string (or Expression with resultType string).
Returns:
getClusterType
public Object getClusterType()
Get the clusterType property: The cluster type. Type: string (or Expression with resultType string).
Returns:
getClusterUserName
public Object getClusterUserName()
Get the clusterUserName property: The username to access the cluster. Type: string (or Expression with resultType string).
Returns:
getCoreConfiguration
public Object getCoreConfiguration()
Get the coreConfiguration property: Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
Returns:
getCredential
public CredentialReference getCredential()
Get the credential property: The credential reference containing authentication information.
Returns:
getDataNodeSize
public Object getDataNodeSize()
Get the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
Returns:
getEncryptedCredential
public Object getEncryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Returns:
getHBaseConfiguration
public Object getHBaseConfiguration()
Get the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
Returns:
getHcatalogLinkedServiceName
public LinkedServiceReference getHcatalogLinkedServiceName()
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:
getHdfsConfiguration
public Object getHdfsConfiguration()
Get the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
Returns:
getHeadNodeSize
public Object getHeadNodeSize()
Get the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
Returns:
getHiveConfiguration
public Object getHiveConfiguration()
Get the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
Returns:
getHostSubscriptionId
public Object getHostSubscriptionId()
Get the hostSubscriptionId property: The customer\u2019s subscription to host the cluster. Type: string (or Expression with resultType string).
Returns:
getLinkedServiceName
public LinkedServiceReference getLinkedServiceName()
Get the linkedServiceName property: Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
Returns:
getMapReduceConfiguration
public Object getMapReduceConfiguration()
Get the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
Returns:
getOozieConfiguration
public Object getOozieConfiguration()
Get the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
Returns:
getScriptActions
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:
getServicePrincipalId
public Object getServicePrincipalId()
Get the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
Returns:
getServicePrincipalKey
public SecretBase getServicePrincipalKey()
Get the servicePrincipalKey property: The key for the service principal id.
Returns:
getSparkVersion
public Object getSparkVersion()
Get the sparkVersion property: The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
Returns:
getStormConfiguration
public Object getStormConfiguration()
Get the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
Returns:
getSubnetName
public Object getSubnetName()
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:
getTenant
public Object getTenant()
Get the tenant property: The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
Returns:
getTimeToLive
public Object getTimeToLive()
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:
getVersion
public Object getVersion()
Get the version property: Version of the HDInsight cluster. Type: string (or Expression with resultType string).
Returns:
getVirtualNetworkId
public Object getVirtualNetworkId()
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:
getYarnConfiguration
public Object getYarnConfiguration()
Get the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
Returns:
getZookeeperNodeSize
public Object getZookeeperNodeSize()
Get the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
Returns:
setAdditionalLinkedServiceNames
public HDInsightOnDemandLinkedService setAdditionalLinkedServiceNames(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:
setAnnotations
public HDInsightOnDemandLinkedService setAnnotations(List
Set the annotations property: List of tags that can be used for describing the linked service.
Overrides:
HDInsightOnDemandLinkedService.setAnnotations(List<Object> annotations)Parameters:
setClusterNamePrefix
public HDInsightOnDemandLinkedService setClusterNamePrefix(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:
setClusterPassword
public HDInsightOnDemandLinkedService setClusterPassword(SecretBase clusterPassword)
Set the clusterPassword property: The password to access the cluster.
Parameters:
Returns:
setClusterResourceGroup
public HDInsightOnDemandLinkedService setClusterResourceGroup(Object clusterResourceGroup)
Set the clusterResourceGroup property: The resource group where the cluster belongs. Type: string (or Expression with resultType string).
Parameters:
Returns:
setClusterSize
public HDInsightOnDemandLinkedService setClusterSize(Object clusterSize)
Set the clusterSize property: Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
Parameters:
Returns:
setClusterSshPassword
public HDInsightOnDemandLinkedService setClusterSshPassword(SecretBase clusterSshPassword)
Set the clusterSshPassword property: The password to SSH remotely connect cluster\u2019s node (for Linux).
Parameters:
Returns:
setClusterSshUserName
public HDInsightOnDemandLinkedService setClusterSshUserName(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:
setClusterType
public HDInsightOnDemandLinkedService setClusterType(Object clusterType)
Set the clusterType property: The cluster type. Type: string (or Expression with resultType string).
Parameters:
Returns:
setClusterUserName
public HDInsightOnDemandLinkedService setClusterUserName(Object clusterUserName)
Set the clusterUserName property: The username to access the cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
setConnectVia
public HDInsightOnDemandLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.
Overrides:
HDInsightOnDemandLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)Parameters:
setCoreConfiguration
public HDInsightOnDemandLinkedService setCoreConfiguration(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:
setCredential
public HDInsightOnDemandLinkedService setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
setDataNodeSize
public HDInsightOnDemandLinkedService setDataNodeSize(Object dataNodeSize)
Set the dataNodeSize property: Specifies the size of the data node for the HDInsight cluster.
Parameters:
Returns:
setDescription
public HDInsightOnDemandLinkedService setDescription(String description)
Set the description property: Linked service description.
Overrides:
HDInsightOnDemandLinkedService.setDescription(String description)Parameters:
setEncryptedCredential
public HDInsightOnDemandLinkedService setEncryptedCredential(Object encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Parameters:
Returns:
setHBaseConfiguration
public HDInsightOnDemandLinkedService setHBaseConfiguration(Object hBaseConfiguration)
Set the hBaseConfiguration property: Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setHcatalogLinkedServiceName
public HDInsightOnDemandLinkedService setHcatalogLinkedServiceName(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:
setHdfsConfiguration
public HDInsightOnDemandLinkedService setHdfsConfiguration(Object hdfsConfiguration)
Set the hdfsConfiguration property: Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setHeadNodeSize
public HDInsightOnDemandLinkedService setHeadNodeSize(Object headNodeSize)
Set the headNodeSize property: Specifies the size of the head node for the HDInsight cluster.
Parameters:
Returns:
setHiveConfiguration
public HDInsightOnDemandLinkedService setHiveConfiguration(Object hiveConfiguration)
Set the hiveConfiguration property: Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setHostSubscriptionId
public HDInsightOnDemandLinkedService setHostSubscriptionId(Object hostSubscriptionId)
Set the hostSubscriptionId property: The customer\u2019s subscription to host the cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
setLinkedServiceName
public HDInsightOnDemandLinkedService setLinkedServiceName(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:
setMapReduceConfiguration
public HDInsightOnDemandLinkedService setMapReduceConfiguration(Object mapReduceConfiguration)
Set the mapReduceConfiguration property: Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setOozieConfiguration
public HDInsightOnDemandLinkedService setOozieConfiguration(Object oozieConfiguration)
Set the oozieConfiguration property: Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setParameters
public HDInsightOnDemandLinkedService setParameters(Map
Set the parameters property: Parameters for linked service.
Overrides:
HDInsightOnDemandLinkedService.setParameters(Map<String,ParameterSpecification> parameters)Parameters:
setScriptActions
public HDInsightOnDemandLinkedService setScriptActions(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:
setServicePrincipalId
public HDInsightOnDemandLinkedService setServicePrincipalId(Object servicePrincipalId)
Set the servicePrincipalId property: The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
Parameters:
Returns:
setServicePrincipalKey
public HDInsightOnDemandLinkedService setServicePrincipalKey(SecretBase servicePrincipalKey)
Set the servicePrincipalKey property: The key for the service principal id.
Parameters:
Returns:
setSparkVersion
public HDInsightOnDemandLinkedService setSparkVersion(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:
setStormConfiguration
public HDInsightOnDemandLinkedService setStormConfiguration(Object stormConfiguration)
Set the stormConfiguration property: Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setSubnetName
public HDInsightOnDemandLinkedService setSubnetName(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:
setTenant
public HDInsightOnDemandLinkedService setTenant(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:
setTimeToLive
public HDInsightOnDemandLinkedService setTimeToLive(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:
setVersion
public HDInsightOnDemandLinkedService setVersion(Object version)
Set the version property: Version of the HDInsight cluster. Type: string (or Expression with resultType string).
Parameters:
Returns:
setVirtualNetworkId
public HDInsightOnDemandLinkedService setVirtualNetworkId(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:
setYarnConfiguration
public HDInsightOnDemandLinkedService setYarnConfiguration(Object yarnConfiguration)
Set the yarnConfiguration property: Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
Parameters:
Returns:
setZookeeperNodeSize
public HDInsightOnDemandLinkedService setZookeeperNodeSize(Object zookeeperNodeSize)
Set the zookeeperNodeSize property: Specifies the size of the Zoo Keeper node for the HDInsight cluster.
Parameters:
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