Feedback Edit

AzureDatabricksLinkedService Class

  • Reference

Azure Databricks linked service.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
AzureDatabricksLinkedService

Constructor

AzureDatabricksLinkedService(*, domain: object, access_token: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, existing_cluster_id: Optional[object] = None, instance_pool_id: Optional[object] = None, new_cluster_version: Optional[object] = None, new_cluster_num_of_worker: Optional[object] = None, new_cluster_node_type: Optional[object] = None, new_cluster_spark_conf: Optional[Dict[str, object]] = None, new_cluster_spark_env_vars: Optional[Dict[str, object]] = None, new_cluster_custom_tags: Optional[Dict[str, object]] = None, new_cluster_driver_node_type: Optional[object] = None, new_cluster_init_scripts: Optional[object] = None, new_cluster_enable_elastic_disk: Optional[object] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of linked service.Constant filled by server.

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

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

domain
object
Required

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

access_token
SecretBase
Required

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

existing_cluster_id
object
Required

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

instance_pool_id
object
Required

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

new_cluster_version
object
Required

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

new_cluster_num_of_worker
object
Required

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

new_cluster_node_type
object
Required

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

new_cluster_spark_conf
dict[str, object]
Required

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

new_cluster_spark_env_vars
dict[str, object]
Required

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

new_cluster_custom_tags
dict[str, object]
Required

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

new_cluster_driver_node_type
object
Required

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

new_cluster_init_scripts
object
Required

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

new_cluster_enable_elastic_disk
object
Required

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

encrypted_credential
object
Required

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