Share via


AzureDatabricksLinkedService Class

Definition

Azure Databricks linked service.

public class AzureDatabricksLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.AzureDatabricksLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.AzureDatabricksLinkedService>
public class AzureDatabricksLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties
type AzureDatabricksLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<AzureDatabricksLinkedService>
    interface IPersistableModel<AzureDatabricksLinkedService>
type AzureDatabricksLinkedService = class
    inherit DataFactoryLinkedServiceProperties
Public Class AzureDatabricksLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of AzureDatabricksLinkedService), IPersistableModel(Of AzureDatabricksLinkedService)
Public Class AzureDatabricksLinkedService
Inherits DataFactoryLinkedServiceProperties
Inheritance
AzureDatabricksLinkedService
Implements

Constructors

AzureDatabricksLinkedService(DataFactoryElement<String>)

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

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
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 DataFactoryLinkedServiceProperties)
Credential

The credential reference containing authentication information.

Description

Linked service description.

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

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

LinkedServiceVersion

Version of the linked service.

(Inherited from DataFactoryLinkedServiceProperties)
NewClusterCustomTags

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

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

NewClusterSparkEnvVars

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

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryLinkedServiceProperties)

Explicit Interface Implementations

IJsonModel<AzureDatabricksLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AzureDatabricksLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<AzureDatabricksLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureDatabricksLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AzureDatabricksLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryLinkedServiceProperties)

Applies to