Share via

AzureDatabricksLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

Azure Databricks linked service.

Extends
LinkedService

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

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

The credential reference containing authentication information.
domain

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

Polymorphic discriminator, which specifies the different types this object can be
workspaceResourceId

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

Inherited Properties

annotations

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

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.

Property Details

accessToken

Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).

accessToken?: SecretBaseUnion

Property Value

SecretBaseUnion

authentication

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

authentication?: any

Property Value

any

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

domain

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

domain: any

Property Value

any

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

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

existingClusterId?: any

Property Value

any

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

instancePoolId?: any

Property Value

any

newClusterCustomTags

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

newClusterCustomTags?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

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

newClusterDriverNodeType?: any

Property Value

any

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

newClusterEnableElasticDisk?: any

Property Value

any

newClusterInitScripts

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

newClusterInitScripts?: any

Property Value

any

newClusterLogDestination

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

newClusterLogDestination?: any

Property Value

any

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

newClusterNodeType?: any

Property Value

any

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

newClusterNumOfWorker?: any

Property Value

any

newClusterSparkConf

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

newClusterSparkConf?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

newClusterSparkEnvVars

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

newClusterSparkEnvVars?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

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

newClusterVersion?: any

Property Value

any

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

policyId?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "AzureDatabricks"

Property Value

"AzureDatabricks"

workspaceResourceId

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

workspaceResourceId?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters