AzureDatabricksLinkedService Class
- java.
lang. Object - com.
azure. analytics. synapse. artifacts. models. LinkedService - com.
azure. analytics. synapse. artifacts. models. AzureDatabricksLinkedService
- com.
- com.
public class AzureDatabricksLinkedService
extends LinkedService
Azure Databricks linked service.
Constructor Summary
| Constructor | Description |
|---|---|
| AzureDatabricksLinkedService() |
Creates an instance of Azure |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Secret |
getAccessToken()
Get the access |
| Object |
getAuthentication()
Get the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. |
|
Credential |
getCredential()
Get the credential property: The credential reference containing authentication information. |
| Object |
getDomain()
Get the domain property: .azuredatabricks. |
| Object |
getEncryptedCredential()
Get the encrypted |
| Object |
getExistingClusterId()
Get the existing |
| Object |
getInstancePoolId()
Get the instance |
| Map<String,Object> |
getNewClusterCustomTags()
Get the new |
| Object |
getNewClusterDriverNodeType()
Get the new |
| Object |
getNewClusterEnableElasticDisk()
Get the new |
| Object |
getNewClusterInitScripts()
Get the new |
| Object |
getNewClusterLogDestination()
Get the new |
| Object |
getNewClusterNodeType()
Get the new |
| Object |
getNewClusterNumOfWorker()
Get the new |
| Map<String,Object> |
getNewClusterSparkConf()
Get the new |
| Map<String,Object> |
getNewClusterSparkEnvVars()
Get the new |
| Object |
getNewClusterVersion()
Get the new |
| Object |
getPolicyId()
Get the policy |
| Object |
getWorkspaceResourceId()
Get the workspace |
|
Azure |
setAccessToken(SecretBase accessToken)
Set the access |
|
Azure |
setAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service. |
|
Azure |
setAuthentication(Object authentication)
Set the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. |
|
Azure |
setConnectVia(IntegrationRuntimeReference connectVia)
Set the connect |
|
Azure |
setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
Azure |
setDescription(String description)
Set the description property: Linked service description. |
|
Azure |
setDomain(Object domain)
Set the domain property: .azuredatabricks. |
|
Azure |
setEncryptedCredential(Object encryptedCredential)
Set the encrypted |
|
Azure |
setExistingClusterId(Object existingClusterId)
Set the existing |
|
Azure |
setInstancePoolId(Object instancePoolId)
Set the instance |
|
Azure |
setNewClusterCustomTags(Map<String,Object> newClusterCustomTags)
Set the new |
|
Azure |
setNewClusterDriverNodeType(Object newClusterDriverNodeType)
Set the new |
|
Azure |
setNewClusterEnableElasticDisk(Object newClusterEnableElasticDisk)
Set the new |
|
Azure |
setNewClusterInitScripts(Object newClusterInitScripts)
Set the new |
|
Azure |
setNewClusterLogDestination(Object newClusterLogDestination)
Set the new |
|
Azure |
setNewClusterNodeType(Object newClusterNodeType)
Set the new |
|
Azure |
setNewClusterNumOfWorker(Object newClusterNumOfWorker)
Set the new |
|
Azure |
setNewClusterSparkConf(Map<String,Object> newClusterSparkConf)
Set the new |
|
Azure |
setNewClusterSparkEnvVars(Map<String,Object> newClusterSparkEnvVars)
Set the new |
|
Azure |
setNewClusterVersion(Object newClusterVersion)
Set the new |
|
Azure |
setParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service. |
|
Azure |
setPolicyId(Object policyId)
Set the policy |
|
Azure |
setWorkspaceResourceId(Object workspaceResourceId)
Set the workspace |
Methods inherited from LinkedService
Methods inherited from java.lang.Object
Constructor Details
AzureDatabricksLinkedService
public AzureDatabricksLinkedService()
Creates an instance of AzureDatabricksLinkedService class.
Method Details
getAccessToken
public SecretBase getAccessToken()
Get the accessToken property: Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
Returns:
getAuthentication
public Object getAuthentication()
Get the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
Returns:
getCredential
public CredentialReference getCredential()
Get the credential property: The credential reference containing authentication information.
Returns:
getDomain
public Object getDomain()
Get the domain property: .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
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:
getExistingClusterId
public Object getExistingClusterId()
Get the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).
Returns:
getInstancePoolId
public Object getInstancePoolId()
Get the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).
Returns:
getNewClusterCustomTags
public Map
Get the newClusterCustomTags property: Additional tags for cluster resources. This property is ignored in instance pool configurations.
Returns:
getNewClusterDriverNodeType
public Object getNewClusterDriverNodeType()
Get the newClusterDriverNodeType property: The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).
Returns:
getNewClusterEnableElasticDisk
public Object getNewClusterEnableElasticDisk()
Get the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).
Returns:
getNewClusterInitScripts
public Object getNewClusterInitScripts()
Get the newClusterInitScripts property: User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).
Returns:
getNewClusterLogDestination
public Object getNewClusterLogDestination()
Get the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
Returns:
getNewClusterNodeType
public Object getNewClusterNodeType()
Get the newClusterNodeType property: The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).
Returns:
getNewClusterNumOfWorker
public Object getNewClusterNumOfWorker()
Get the newClusterNumOfWorker property: If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).
Returns:
getNewClusterSparkConf
public Map
Get the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.
Returns:
getNewClusterSparkEnvVars
public Map
Get the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.
Returns:
getNewClusterVersion
public Object getNewClusterVersion()
Get the newClusterVersion property: If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).
Returns:
getPolicyId
public Object getPolicyId()
Get the policyId property: The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).
Returns:
getWorkspaceResourceId
public Object getWorkspaceResourceId()
Get the workspaceResourceId property: Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
Returns:
setAccessToken
public AzureDatabricksLinkedService setAccessToken(SecretBase accessToken)
Set the accessToken property: Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
Parameters:
Returns:
setAnnotations
public AzureDatabricksLinkedService setAnnotations(List
Set the annotations property: List of tags that can be used for describing the linked service.
Overrides:
AzureDatabricksLinkedService.setAnnotations(List<Object> annotations)Parameters:
setAuthentication
public AzureDatabricksLinkedService setAuthentication(Object authentication)
Set the authentication property: Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
Parameters:
Returns:
setConnectVia
public AzureDatabricksLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.
Overrides:
AzureDatabricksLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)Parameters:
setCredential
public AzureDatabricksLinkedService setCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
setDescription
public AzureDatabricksLinkedService setDescription(String description)
Set the description property: Linked service description.
Overrides:
AzureDatabricksLinkedService.setDescription(String description)Parameters:
setDomain
public AzureDatabricksLinkedService setDomain(Object domain)
Set the domain property: .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
Parameters:
Returns:
setEncryptedCredential
public AzureDatabricksLinkedService 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:
setExistingClusterId
public AzureDatabricksLinkedService setExistingClusterId(Object existingClusterId)
Set the existingClusterId property: The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).
Parameters:
Returns:
setInstancePoolId
public AzureDatabricksLinkedService setInstancePoolId(Object instancePoolId)
Set the instancePoolId property: The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).
Parameters:
Returns:
setNewClusterCustomTags
public AzureDatabricksLinkedService setNewClusterCustomTags(Map
Set the newClusterCustomTags property: Additional tags for cluster resources. This property is ignored in instance pool configurations.
Parameters:
Returns:
setNewClusterDriverNodeType
public AzureDatabricksLinkedService setNewClusterDriverNodeType(Object newClusterDriverNodeType)
Set the newClusterDriverNodeType property: The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).
Parameters:
Returns:
setNewClusterEnableElasticDisk
public AzureDatabricksLinkedService setNewClusterEnableElasticDisk(Object newClusterEnableElasticDisk)
Set the newClusterEnableElasticDisk property: Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).
Parameters:
Returns:
setNewClusterInitScripts
public AzureDatabricksLinkedService setNewClusterInitScripts(Object newClusterInitScripts)
Set the newClusterInitScripts property: User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).
Parameters:
Returns:
setNewClusterLogDestination
public AzureDatabricksLinkedService setNewClusterLogDestination(Object newClusterLogDestination)
Set the newClusterLogDestination property: Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
Parameters:
Returns:
setNewClusterNodeType
public AzureDatabricksLinkedService setNewClusterNodeType(Object newClusterNodeType)
Set the newClusterNodeType property: The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).
Parameters:
Returns:
setNewClusterNumOfWorker
public AzureDatabricksLinkedService setNewClusterNumOfWorker(Object newClusterNumOfWorker)
Set the newClusterNumOfWorker property: If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).
Parameters:
Returns:
setNewClusterSparkConf
public AzureDatabricksLinkedService setNewClusterSparkConf(Map
Set the newClusterSparkConf property: A set of optional, user-specified Spark configuration key-value pairs.
Parameters:
Returns:
setNewClusterSparkEnvVars
public AzureDatabricksLinkedService setNewClusterSparkEnvVars(Map
Set the newClusterSparkEnvVars property: A set of optional, user-specified Spark environment variables key-value pairs.
Parameters:
Returns:
setNewClusterVersion
public AzureDatabricksLinkedService setNewClusterVersion(Object newClusterVersion)
Set the newClusterVersion property: If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).
Parameters:
Returns:
setParameters
public AzureDatabricksLinkedService setParameters(Map
Set the parameters property: Parameters for linked service.
Overrides:
AzureDatabricksLinkedService.setParameters(Map<String,ParameterSpecification> parameters)Parameters:
setPolicyId
public AzureDatabricksLinkedService setPolicyId(Object policyId)
Set the policyId property: The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).
Parameters:
Returns:
setWorkspaceResourceId
public AzureDatabricksLinkedService setWorkspaceResourceId(Object workspaceResourceId)
Set the workspaceResourceId property: Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
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