Class AzureDatabricksLinkedService

Azure Databricks linked service.

Inheritance
System.Object
LinkedService
AzureDatabricksLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureDatabricksLinkedService/AzureDatabricksLinkedServiceConverter))]
public class AzureDatabricksLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

AzureDatabricksLinkedService(Object)

Initializes a new instance of AzureDatabricksLinkedService.

Declaration
public AzureDatabricksLinkedService (object domain);
Parameters
System.Object domain

<REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
Exceptions
System.ArgumentNullException

domain is null.

Properties

AccessToken

Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase AccessToken { get; set; }
Property Value
SecretBase

Authentication

Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

Declaration
public object Authentication { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

Domain

<REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

Declaration
public object Domain { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

ExistingClusterId

The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).

Declaration
public object ExistingClusterId { get; set; }
Property Value
System.Object

InstancePoolId

The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).

Declaration
public object InstancePoolId { get; set; }
Property Value
System.Object

NewClusterCustomTags

Additional tags for cluster resources. This property is ignored in instance pool configurations.

Declaration
public System.Collections.Generic.IDictionary<string,object> NewClusterCustomTags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,System.Object>

NewClusterDriverNodeType

The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).

Declaration
public object NewClusterDriverNodeType { get; set; }
Property Value
System.Object

NewClusterEnableElasticDisk

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

Declaration
public object NewClusterEnableElasticDisk { get; set; }
Property Value
System.Object

NewClusterInitScripts

User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).

Declaration
public object NewClusterInitScripts { get; set; }
Property Value
System.Object

NewClusterLogDestination

Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).

Declaration
public object NewClusterLogDestination { get; set; }
Property Value
System.Object

NewClusterNodeType

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

Declaration
public object NewClusterNodeType { get; set; }
Property Value
System.Object

NewClusterNumOfWorker

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

Declaration
public object NewClusterNumOfWorker { get; set; }
Property Value
System.Object

NewClusterSparkConf

A set of optional, user-specified Spark configuration key-value pairs.

Declaration
public System.Collections.Generic.IDictionary<string,object> NewClusterSparkConf { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,System.Object>

NewClusterSparkEnvVars

A set of optional, user-specified Spark environment variables key-value pairs.

Declaration
public System.Collections.Generic.IDictionary<string,object> NewClusterSparkEnvVars { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,System.Object>

NewClusterVersion

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

Declaration
public object NewClusterVersion { get; set; }
Property Value
System.Object

PolicyId

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

Declaration
public object PolicyId { get; set; }
Property Value
System.Object

WorkspaceResourceId

Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

Declaration
public object WorkspaceResourceId { get; set; }
Property Value
System.Object