Share via

AzureDatabricksLinkedService Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
AzureDatabricksLinkedService.cs

Azure Databricks linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureDatabricksLinkedService+AzureDatabricksLinkedServiceConverter))]
public class AzureDatabricksLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureDatabricksLinkedService+AzureDatabricksLinkedServiceConverter))>]
type AzureDatabricksLinkedService = class
    inherit LinkedService
Public Class AzureDatabricksLinkedService
Inherits LinkedService
Inheritance
Object
LinkedService
AzureDatabricksLinkedService
Attributes
JsonConverterAttribute

Constructors

AzureDatabricksLinkedService(Object)

Initializes a new instance of AzureDatabricksLinkedService.

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

Additional Properties.

(Inherited from LinkedService)
Annotations

List of tags that can be used for describing the linked service.

(Inherited from LinkedService)
Authentication

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

The integration runtime reference.

(Inherited from LinkedService)
Credential

The credential reference containing authentication information.
Description

Linked service description.

(Inherited from LinkedService)
Domain

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

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
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).
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).
NewClusterCustomTags

Additional tags for cluster resources. This property is ignored in instance pool configurations.
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).
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).
NewClusterInitScripts

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

Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
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).
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).
NewClusterSparkConf

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

A set of optional, user-specified Spark environment variables key-value pairs.
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).
Parameters

Parameters for linked service.

(Inherited from LinkedService)
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).
WorkspaceResourceId

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

Applies to