Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. Connection
Viewing docs for Databricks v1.96.0
published on Thursday, Jun 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.Connection

databricks logo
Viewing docs for Databricks v1.96.0
published on Thursday, Jun 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    API Documentation

    This resource can only be used with a workspace-level provider!

    Lakehouse Federation is the query federation platform for Databricks. Databricks uses Unity Catalog to manage query federation. To make a dataset available for read-only querying using Lakehouse Federation, you create the following:

    • A connection, a securable object in Unity Catalog that specifies a path and credentials for accessing an external database system.
    • A foreign catalog

    This resource manages connections in Unity Catalog. Please note that OAuth U2M is not supported as it requires user interaction for authentication.

    Example Usage

    Create a connection to a MySQL database

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const mysql = new databricks.Connection("mysql", {
    name: "mysql_connection",
    connectionType: "MYSQL",
    comment: "this is a connection to mysql db",
    options: {
        host: "test.mysql.database.azure.com",
        port: "3306",
        user: "user",
        password: "password",
    },
    properties: {
        purpose: "testing",
    },
});

    import pulumi
import pulumi_databricks as databricks

mysql = databricks.Connection("mysql",
    name="mysql_connection",
    connection_type="MYSQL",
    comment="this is a connection to mysql db",
    options={
        "host": "test.mysql.database.azure.com",
        "port": "3306",
        "user": "user",
        "password": "password",
    },
    properties={
        "purpose": "testing",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewConnection(ctx, "mysql", &databricks.ConnectionArgs{
			Name:           pulumi.String("mysql_connection"),
			ConnectionType: pulumi.String("MYSQL"),
			Comment:        pulumi.String("this is a connection to mysql db"),
			Options: pulumi.StringMap{
				"host":     pulumi.String("test.mysql.database.azure.com"),
				"port":     pulumi.String("3306"),
				"user":     pulumi.String("user"),
				"password": pulumi.String("password"),
			},
			Properties: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var mysql = new Databricks.Connection("mysql", new()
    {
        Name = "mysql_connection",
        ConnectionType = "MYSQL",
        Comment = "this is a connection to mysql db",
        Options = 
        {
            { "host", "test.mysql.database.azure.com" },
            { "port", "3306" },
            { "user", "user" },
            { "password", "password" },
        },
        Properties = 
        {
            { "purpose", "testing" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mysql = new Connection("mysql", ConnectionArgs.builder()
            .name("mysql_connection")
            .connectionType("MYSQL")
            .comment("this is a connection to mysql db")
            .options(Map.ofEntries(
                Map.entry("host", "test.mysql.database.azure.com"),
                Map.entry("port", "3306"),
                Map.entry("user", "user"),
                Map.entry("password", "password")
            ))
            .properties(Map.of("purpose", "testing"))
            .build());

    }
}

    resources:
  mysql:
    type: databricks:Connection
    properties:
      name: mysql_connection
      connectionType: MYSQL
      comment: this is a connection to mysql db
      options:
        host: test.mysql.database.azure.com
        port: '3306'
        user: user
        password: password
      properties:
        purpose: testing

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "mysql" {
  name            = "mysql_connection"
  connection_type = "MYSQL"
  comment         = "this is a connection to mysql db"
  options = {
    "host"     = "test.mysql.database.azure.com"
    "port"     = "3306"
    "user"     = "user"
    "password" = "password"
  }
  properties = {
    "purpose" = "testing"
  }
}

    Create a connection to a BigQuery database

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const bigquery = new databricks.Connection("bigquery", {
    name: "bq_connection",
    connectionType: "BIGQUERY",
    comment: "this is a connection to BQ",
    options: {
        GoogleServiceAccountKeyJson: JSON.stringify({
            type: "service_account",
            project_id: "PROJECT_ID",
            private_key_id: "KEY_ID",
            private_key: `-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
`,
            client_email: "SERVICE_ACCOUNT_EMAIL",
            client_id: "CLIENT_ID",
            auth_uri: "https://accounts.google.com/o/oauth2/auth",
            token_uri: "https://accounts.google.com/o/oauth2/token",
            auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
            client_x509_cert_url: "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
            universe_domain: "googleapis.com",
        }),
    },
    properties: {
        purpose: "testing",
    },
});

    import pulumi
import json
import pulumi_databricks as databricks

bigquery = databricks.Connection("bigquery",
    name="bq_connection",
    connection_type="BIGQUERY",
    comment="this is a connection to BQ",
    options={
        "GoogleServiceAccountKeyJson": json.dumps({
            "type": "service_account",
            "project_id": "PROJECT_ID",
            "private_key_id": "KEY_ID",
            "private_key": """-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
""",
            "client_email": "SERVICE_ACCOUNT_EMAIL",
            "client_id": "CLIENT_ID",
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": "https://accounts.google.com/o/oauth2/token",
            "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
            "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
            "universe_domain": "googleapis.com",
        }),
    },
    properties={
        "purpose": "testing",
    })

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"type":                        "service_account",
			"project_id":                  "PROJECT_ID",
			"private_key_id":              "KEY_ID",
			"private_key":                 "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n",
			"client_email":                "SERVICE_ACCOUNT_EMAIL",
			"client_id":                   "CLIENT_ID",
			"auth_uri":                    "https://accounts.google.com/o/oauth2/auth",
			"token_uri":                   "https://accounts.google.com/o/oauth2/token",
			"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
			"client_x509_cert_url":        "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
			"universe_domain":             "googleapis.com",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = databricks.NewConnection(ctx, "bigquery", &databricks.ConnectionArgs{
			Name:           pulumi.String("bq_connection"),
			ConnectionType: pulumi.String("BIGQUERY"),
			Comment:        pulumi.String("this is a connection to BQ"),
			Options: pulumi.StringMap{
				"GoogleServiceAccountKeyJson": pulumi.String(json0),
			},
			Properties: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var bigquery = new Databricks.Connection("bigquery", new()
    {
        Name = "bq_connection",
        ConnectionType = "BIGQUERY",
        Comment = "this is a connection to BQ",
        Options = 
        {
            { "GoogleServiceAccountKeyJson", JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["type"] = "service_account",
                ["project_id"] = "PROJECT_ID",
                ["private_key_id"] = "KEY_ID",
                ["private_key"] = @"-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
",
                ["client_email"] = "SERVICE_ACCOUNT_EMAIL",
                ["client_id"] = "CLIENT_ID",
                ["auth_uri"] = "https://accounts.google.com/o/oauth2/auth",
                ["token_uri"] = "https://accounts.google.com/o/oauth2/token",
                ["auth_provider_x509_cert_url"] = "https://www.googleapis.com/oauth2/v1/certs",
                ["client_x509_cert_url"] = "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL",
                ["universe_domain"] = "googleapis.com",
            }) },
        },
        Properties = 
        {
            { "purpose", "testing" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bigquery = new Connection("bigquery", ConnectionArgs.builder()
            .name("bq_connection")
            .connectionType("BIGQUERY")
            .comment("this is a connection to BQ")
            .options(Map.of("GoogleServiceAccountKeyJson", serializeJson(
                jsonObject(
                    jsonProperty("type", "service_account"),
                    jsonProperty("project_id", "PROJECT_ID"),
                    jsonProperty("private_key_id", "KEY_ID"),
                    jsonProperty("private_key", """
-----BEGIN PRIVATE KEY-----
PRIVATE_KEY
-----END PRIVATE KEY-----
                    """),
                    jsonProperty("client_email", "SERVICE_ACCOUNT_EMAIL"),
                    jsonProperty("client_id", "CLIENT_ID"),
                    jsonProperty("auth_uri", "https://accounts.google.com/o/oauth2/auth"),
                    jsonProperty("token_uri", "https://accounts.google.com/o/oauth2/token"),
                    jsonProperty("auth_provider_x509_cert_url", "https://www.googleapis.com/oauth2/v1/certs"),
                    jsonProperty("client_x509_cert_url", "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL"),
                    jsonProperty("universe_domain", "googleapis.com")
                ))))
            .properties(Map.of("purpose", "testing"))
            .build());

    }
}

    resources:
  bigquery:
    type: databricks:Connection
    properties:
      name: bq_connection
      connectionType: BIGQUERY
      comment: this is a connection to BQ
      options:
        GoogleServiceAccountKeyJson:
          fn::toJSON:
            type: service_account
            project_id: PROJECT_ID
            private_key_id: KEY_ID
            private_key: |
              -----BEGIN PRIVATE KEY-----
              PRIVATE_KEY
              -----END PRIVATE KEY-----
            client_email: SERVICE_ACCOUNT_EMAIL
            client_id: CLIENT_ID
            auth_uri: https://accounts.google.com/o/oauth2/auth
            token_uri: https://accounts.google.com/o/oauth2/token
            auth_provider_x509_cert_url: https://www.googleapis.com/oauth2/v1/certs
            client_x509_cert_url: https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL
            universe_domain: googleapis.com
      properties:
        purpose: testing

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "bigquery" {
  name            = "bq_connection"
  connection_type = "BIGQUERY"
  comment         = "this is a connection to BQ"
  options = {
    "GoogleServiceAccountKeyJson" = jsonencode({
      "type"                        = "service_account"
      "project_id"                  = "PROJECT_ID"
      "private_key_id"              = "KEY_ID"
      "private_key"                 = "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n"
      "client_email"                = "SERVICE_ACCOUNT_EMAIL"
      "client_id"                   = "CLIENT_ID"
      "auth_uri"                    = "https://accounts.google.com/o/oauth2/auth"
      "token_uri"                   = "https://accounts.google.com/o/oauth2/token"
      "auth_provider_x509_cert_url" = "https://www.googleapis.com/oauth2/v1/certs"
      "client_x509_cert_url"        = "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL"
      "universe_domain"             = "googleapis.com"
    })
  }
  properties = {
    "purpose" = "testing"
  }
}

    Create a connection to builtin Hive Metastore

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const hms = new databricks.Connection("hms", {
    name: "hms-builtin",
    connectionType: "HIVE_METASTORE",
    comment: "This is a connection to builtin HMS",
    options: {
        builtin: "true",
    },
});

    import pulumi
import pulumi_databricks as databricks

hms = databricks.Connection("hms",
    name="hms-builtin",
    connection_type="HIVE_METASTORE",
    comment="This is a connection to builtin HMS",
    options={
        "builtin": "true",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewConnection(ctx, "hms", &databricks.ConnectionArgs{
			Name:           pulumi.String("hms-builtin"),
			ConnectionType: pulumi.String("HIVE_METASTORE"),
			Comment:        pulumi.String("This is a connection to builtin HMS"),
			Options: pulumi.StringMap{
				"builtin": pulumi.String("true"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var hms = new Databricks.Connection("hms", new()
    {
        Name = "hms-builtin",
        ConnectionType = "HIVE_METASTORE",
        Comment = "This is a connection to builtin HMS",
        Options = 
        {
            { "builtin", "true" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var hms = new Connection("hms", ConnectionArgs.builder()
            .name("hms-builtin")
            .connectionType("HIVE_METASTORE")
            .comment("This is a connection to builtin HMS")
            .options(Map.of("builtin", "true"))
            .build());

    }
}

    resources:
  hms:
    type: databricks:Connection
    properties:
      name: hms-builtin
      connectionType: HIVE_METASTORE
      comment: This is a connection to builtin HMS
      options:
        builtin: 'true'

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "hms" {
  name            = "hms-builtin"
  connection_type = "HIVE_METASTORE"
  comment         = "This is a connection to builtin HMS"
  options = {
    "builtin" = "true"
  }
}

    Create a HTTP connection with bearer token

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const httpBearer = new databricks.Connection("http_bearer", {
    name: "http_bearer",
    connectionType: "HTTP",
    comment: "This is a connection to a HTTP service",
    options: {
        host: "https://example.com",
        port: "8433",
        base_path: "/api/",
        bearer_token: "bearer_token",
    },
});

    import pulumi
import pulumi_databricks as databricks

http_bearer = databricks.Connection("http_bearer",
    name="http_bearer",
    connection_type="HTTP",
    comment="This is a connection to a HTTP service",
    options={
        "host": "https://example.com",
        "port": "8433",
        "base_path": "/api/",
        "bearer_token": "bearer_token",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewConnection(ctx, "http_bearer", &databricks.ConnectionArgs{
			Name:           pulumi.String("http_bearer"),
			ConnectionType: pulumi.String("HTTP"),
			Comment:        pulumi.String("This is a connection to a HTTP service"),
			Options: pulumi.StringMap{
				"host":         pulumi.String("https://example.com"),
				"port":         pulumi.String("8433"),
				"base_path":    pulumi.String("/api/"),
				"bearer_token": pulumi.String("bearer_token"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var httpBearer = new Databricks.Connection("http_bearer", new()
    {
        Name = "http_bearer",
        ConnectionType = "HTTP",
        Comment = "This is a connection to a HTTP service",
        Options = 
        {
            { "host", "https://example.com" },
            { "port", "8433" },
            { "base_path", "/api/" },
            { "bearer_token", "bearer_token" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var httpBearer = new Connection("httpBearer", ConnectionArgs.builder()
            .name("http_bearer")
            .connectionType("HTTP")
            .comment("This is a connection to a HTTP service")
            .options(Map.ofEntries(
                Map.entry("host", "https://example.com"),
                Map.entry("port", "8433"),
                Map.entry("base_path", "/api/"),
                Map.entry("bearer_token", "bearer_token")
            ))
            .build());

    }
}

    resources:
  httpBearer:
    type: databricks:Connection
    name: http_bearer
    properties:
      name: http_bearer
      connectionType: HTTP
      comment: This is a connection to a HTTP service
      options:
        host: https://example.com
        port: '8433'
        base_path: /api/
        bearer_token: bearer_token

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "http_bearer" {
  name            = "http_bearer"
  connection_type = "HTTP"
  comment         = "This is a connection to a HTTP service"
  options = {
    "host"         = "https://example.com"
    "port"         = "8433"
    "base_path"    = "/api/"
    "bearer_token" = "bearer_token"
  }
}

    Create a HTTP connection with OAuth M2M

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const httpOauth = new databricks.Connection("http_oauth", {
    name: "http_oauth",
    connectionType: "HTTP",
    comment: "This is a connection to a HTTP service",
    options: {
        host: "https://example.com",
        port: "8433",
        base_path: "/api/",
        client_id: "client_id",
        client_secret: "client_secret",
        oauth_scope: "channels:read channels:history chat:write",
        token_endpoint: "https://authorization-server.com/oauth/token",
    },
});

    import pulumi
import pulumi_databricks as databricks

http_oauth = databricks.Connection("http_oauth",
    name="http_oauth",
    connection_type="HTTP",
    comment="This is a connection to a HTTP service",
    options={
        "host": "https://example.com",
        "port": "8433",
        "base_path": "/api/",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "oauth_scope": "channels:read channels:history chat:write",
        "token_endpoint": "https://authorization-server.com/oauth/token",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewConnection(ctx, "http_oauth", &databricks.ConnectionArgs{
			Name:           pulumi.String("http_oauth"),
			ConnectionType: pulumi.String("HTTP"),
			Comment:        pulumi.String("This is a connection to a HTTP service"),
			Options: pulumi.StringMap{
				"host":           pulumi.String("https://example.com"),
				"port":           pulumi.String("8433"),
				"base_path":      pulumi.String("/api/"),
				"client_id":      pulumi.String("client_id"),
				"client_secret":  pulumi.String("client_secret"),
				"oauth_scope":    pulumi.String("channels:read channels:history chat:write"),
				"token_endpoint": pulumi.String("https://authorization-server.com/oauth/token"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var httpOauth = new Databricks.Connection("http_oauth", new()
    {
        Name = "http_oauth",
        ConnectionType = "HTTP",
        Comment = "This is a connection to a HTTP service",
        Options = 
        {
            { "host", "https://example.com" },
            { "port", "8433" },
            { "base_path", "/api/" },
            { "client_id", "client_id" },
            { "client_secret", "client_secret" },
            { "oauth_scope", "channels:read channels:history chat:write" },
            { "token_endpoint", "https://authorization-server.com/oauth/token" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var httpOauth = new Connection("httpOauth", ConnectionArgs.builder()
            .name("http_oauth")
            .connectionType("HTTP")
            .comment("This is a connection to a HTTP service")
            .options(Map.ofEntries(
                Map.entry("host", "https://example.com"),
                Map.entry("port", "8433"),
                Map.entry("base_path", "/api/"),
                Map.entry("client_id", "client_id"),
                Map.entry("client_secret", "client_secret"),
                Map.entry("oauth_scope", "channels:read channels:history chat:write"),
                Map.entry("token_endpoint", "https://authorization-server.com/oauth/token")
            ))
            .build());

    }
}

    resources:
  httpOauth:
    type: databricks:Connection
    name: http_oauth
    properties:
      name: http_oauth
      connectionType: HTTP
      comment: This is a connection to a HTTP service
      options:
        host: https://example.com
        port: '8433'
        base_path: /api/
        client_id: client_id
        client_secret: client_secret
        oauth_scope: channels:read channels:history chat:write
        token_endpoint: https://authorization-server.com/oauth/token

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "http_oauth" {
  name            = "http_oauth"
  connection_type = "HTTP"
  comment         = "This is a connection to a HTTP service"
  options = {
    "host"           = "https://example.com"
    "port"           = "8433"
    "base_path"      = "/api/"
    "client_id"      = "client_id"
    "client_secret"  = "client_secret"
    "oauth_scope"    = "channels:read channels:history chat:write"
    "token_endpoint" = "https://authorization-server.com/oauth/token"
  }
}

    Create a PowerBI connection with OAuth M2M

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const pbi = new databricks.Connection("pbi", {
    name: "test-pbi",
    connectionType: "POWER_BI",
    options: {
        authorization_endpoint: "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize",
        client_id: "client_id",
        client_secret: "client_secret",
    },
});

    import pulumi
import pulumi_databricks as databricks

pbi = databricks.Connection("pbi",
    name="test-pbi",
    connection_type="POWER_BI",
    options={
        "authorization_endpoint": "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize",
        "client_id": "client_id",
        "client_secret": "client_secret",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewConnection(ctx, "pbi", &databricks.ConnectionArgs{
			Name:           pulumi.String("test-pbi"),
			ConnectionType: pulumi.String("POWER_BI"),
			Options: pulumi.StringMap{
				"authorization_endpoint": pulumi.String("https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize"),
				"client_id":              pulumi.String("client_id"),
				"client_secret":          pulumi.String("client_secret"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var pbi = new Databricks.Connection("pbi", new()
    {
        Name = "test-pbi",
        ConnectionType = "POWER_BI",
        Options = 
        {
            { "authorization_endpoint", "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize" },
            { "client_id", "client_id" },
            { "client_secret", "client_secret" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Connection;
import com.pulumi.databricks.ConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pbi = new Connection("pbi", ConnectionArgs.builder()
            .name("test-pbi")
            .connectionType("POWER_BI")
            .options(Map.ofEntries(
                Map.entry("authorization_endpoint", "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize"),
                Map.entry("client_id", "client_id"),
                Map.entry("client_secret", "client_secret")
            ))
            .build());

    }
}

    resources:
  pbi:
    type: databricks:Connection
    properties:
      name: test-pbi
      connectionType: POWER_BI
      options:
        authorization_endpoint: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize
        client_id: client_id
        client_secret: client_secret

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_connection" "pbi" {
  name            = "test-pbi"
  connection_type = "POWER_BI"
  options = {
    "authorization_endpoint" = "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize"
    "client_id"              = "client_id"
    "client_secret"          = "client_secret"
  }
}

    Create Connection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
def Connection(resource_name: str,
               args: Optional[ConnectionArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               comment: Optional[str] = None,
               connection_type: Optional[str] = None,
               environment_settings: Optional[ConnectionEnvironmentSettingsArgs] = None,
               name: Optional[str] = None,
               options: Optional[Mapping[str, str]] = None,
               owner: Optional[str] = None,
               properties: Optional[Mapping[str, str]] = None,
               provider_config: Optional[ConnectionProviderConfigArgs] = None,
               read_only: Optional[bool] = None)
    func NewConnection(ctx *Context, name string, args *ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs? args = null, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

    type: databricks:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "databricks_connection" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var connectionResource = new Databricks.Connection("connectionResource", new()
{
    Comment = "string",
    ConnectionType = "string",
    EnvironmentSettings = new Databricks.Inputs.ConnectionEnvironmentSettingsArgs
    {
        EnvironmentVersion = "string",
        JavaDependencies = new[]
        {
            "string",
        },
    },
    Name = "string",
    Options = 
    {
        { "string", "string" },
    },
    Owner = "string",
    Properties = 
    {
        { "string", "string" },
    },
    ProviderConfig = new Databricks.Inputs.ConnectionProviderConfigArgs
    {
        WorkspaceId = "string",
    },
    ReadOnly = false,
});

    example, err := databricks.NewConnection(ctx, "connectionResource", &databricks.ConnectionArgs{
	Comment:        pulumi.String("string"),
	ConnectionType: pulumi.String("string"),
	EnvironmentSettings: &databricks.ConnectionEnvironmentSettingsArgs{
		EnvironmentVersion: pulumi.String("string"),
		JavaDependencies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Owner: pulumi.String("string"),
	Properties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ProviderConfig: &databricks.ConnectionProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
	ReadOnly: pulumi.Bool(false),
})

    resource "databricks_connection" "connectionResource" {
  comment         = "string"
  connection_type = "string"
  environment_settings = {
    environment_version = "string"
    java_dependencies   = ["string"]
  }
  name = "string"
  options = {
    "string" = "string"
  }
  owner = "string"
  properties = {
    "string" = "string"
  }
  provider_config = {
    workspace_id = "string"
  }
  read_only = false
}

    var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
    .comment("string")
    .connectionType("string")
    .environmentSettings(ConnectionEnvironmentSettingsArgs.builder()
        .environmentVersion("string")
        .javaDependencies("string")
        .build())
    .name("string")
    .options(Map.of("string", "string"))
    .owner("string")
    .properties(Map.of("string", "string"))
    .providerConfig(ConnectionProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .readOnly(false)
    .build());

    connection_resource = databricks.Connection("connectionResource",
    comment="string",
    connection_type="string",
    environment_settings={
        "environment_version": "string",
        "java_dependencies": ["string"],
    },
    name="string",
    options={
        "string": "string",
    },
    owner="string",
    properties={
        "string": "string",
    },
    provider_config={
        "workspace_id": "string",
    },
    read_only=False)

    const connectionResource = new databricks.Connection("connectionResource", {
    comment: "string",
    connectionType: "string",
    environmentSettings: {
        environmentVersion: "string",
        javaDependencies: ["string"],
    },
    name: "string",
    options: {
        string: "string",
    },
    owner: "string",
    properties: {
        string: "string",
    },
    providerConfig: {
        workspaceId: "string",
    },
    readOnly: false,
});

    type: databricks:Connection
properties:
    comment: string
    connectionType: string
    environmentSettings:
        environmentVersion: string
        javaDependencies:
            - string
    name: string
    options:
        string: string
    owner: string
    properties:
        string: string
    providerConfig:
        workspaceId: string
    readOnly: false

    Connection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Connection resource accepts the following input properties:

    Comment string
    User-provided free-form text description. Change forces creation of a new resource.
    ConnectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    EnvironmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    Name string
    Name of the connection.
    Options Dictionary<string, string>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    Owner string
    Username of current owner of the connection.
    Properties Dictionary<string, string>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    ProviderConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    ReadOnly bool
    If the connection is read only. Change forces creation of a new resource.
    Comment string
    User-provided free-form text description. Change forces creation of a new resource.
    ConnectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    EnvironmentSettings ConnectionEnvironmentSettingsArgs
    Connection environment settings. This block consists of the following fields:
    Name string
    Name of the connection.
    Options map[string]string
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    Owner string
    Username of current owner of the connection.
    Properties map[string]string
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    ProviderConfig ConnectionProviderConfigArgs
    Configure the provider for management through account provider. This block consists of the following fields:
    ReadOnly bool
    If the connection is read only. Change forces creation of a new resource.
    comment string
    User-provided free-form text description. Change forces creation of a new resource.
    connection_type string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    environment_settings object
    Connection environment settings. This block consists of the following fields:
    name string
    Name of the connection.
    options map(string)
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner string
    Username of current owner of the connection.
    properties map(string)
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    provider_config object
    Configure the provider for management through account provider. This block consists of the following fields:
    read_only bool
    If the connection is read only. Change forces creation of a new resource.
    comment String
    User-provided free-form text description. Change forces creation of a new resource.
    connectionType String
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    environmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    name String
    Name of the connection.
    options Map<String,String>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner String
    Username of current owner of the connection.
    properties Map<String,String>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    readOnly Boolean
    If the connection is read only. Change forces creation of a new resource.
    comment string
    User-provided free-form text description. Change forces creation of a new resource.
    connectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    environmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    name string
    Name of the connection.
    options {[key: string]: string}
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner string
    Username of current owner of the connection.
    properties {[key: string]: string}
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    readOnly boolean
    If the connection is read only. Change forces creation of a new resource.
    comment str
    User-provided free-form text description. Change forces creation of a new resource.
    connection_type str
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    environment_settings ConnectionEnvironmentSettingsArgs
    Connection environment settings. This block consists of the following fields:
    name str
    Name of the connection.
    options Mapping[str, str]
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner str
    Username of current owner of the connection.
    properties Mapping[str, str]
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    provider_config ConnectionProviderConfigArgs
    Configure the provider for management through account provider. This block consists of the following fields:
    read_only bool
    If the connection is read only. Change forces creation of a new resource.
    comment String
    User-provided free-form text description. Change forces creation of a new resource.
    connectionType String
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    environmentSettings Property Map
    Connection environment settings. This block consists of the following fields:
    name String
    Name of the connection.
    options Map<String>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner String
    Username of current owner of the connection.
    properties Map<String>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig Property Map
    Configure the provider for management through account provider. This block consists of the following fields:
    readOnly Boolean
    If the connection is read only. Change forces creation of a new resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

    ConnectionId string
    Unique identifier of the Connection.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential.
    FullName string
    Full name of connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    Unique identifier of parent metastore.
    ProvisioningInfos List<ConnectionProvisioningInfo>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    SecurableType string
    Securable type.
    UpdatedAt int
    Time at which this connection was updated, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified connection.
    Url string
    URL of the remote data source, extracted from options.
    ConnectionId string
    Unique identifier of the Connection.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential.
    FullName string
    Full name of connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    Unique identifier of parent metastore.
    ProvisioningInfos []ConnectionProvisioningInfo
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    SecurableType string
    Securable type.
    UpdatedAt int
    Time at which this connection was updated, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified connection.
    Url string
    URL of the remote data source, extracted from options.
    connection_id string
    Unique identifier of the Connection.
    created_at number
    Time at which this connection was created, in epoch milliseconds.
    created_by string
    Username of connection creator.
    credential_type string
    The type of credential.
    full_name string
    Full name of connection.
    id string
    The provider-assigned unique ID for this managed resource.
    metastore_id string
    Unique identifier of parent metastore.
    provisioning_infos list(object)
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    securable_type string
    Securable type.
    updated_at number
    Time at which this connection was updated, in epoch milliseconds.
    updated_by string
    Username of user who last modified connection.
    url string
    URL of the remote data source, extracted from options.
    connectionId String
    Unique identifier of the Connection.
    createdAt Integer
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential.
    fullName String
    Full name of connection.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String
    Unique identifier of parent metastore.
    provisioningInfos List<ConnectionProvisioningInfo>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    securableType String
    Securable type.
    updatedAt Integer
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy String
    Username of user who last modified connection.
    url String
    URL of the remote data source, extracted from options.
    connectionId string
    Unique identifier of the Connection.
    createdAt number
    Time at which this connection was created, in epoch milliseconds.
    createdBy string
    Username of connection creator.
    credentialType string
    The type of credential.
    fullName string
    Full name of connection.
    id string
    The provider-assigned unique ID for this managed resource.
    metastoreId string
    Unique identifier of parent metastore.
    provisioningInfos ConnectionProvisioningInfo[]
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    securableType string
    Securable type.
    updatedAt number
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy string
    Username of user who last modified connection.
    url string
    URL of the remote data source, extracted from options.
    connection_id str
    Unique identifier of the Connection.
    created_at int
    Time at which this connection was created, in epoch milliseconds.
    created_by str
    Username of connection creator.
    credential_type str
    The type of credential.
    full_name str
    Full name of connection.
    id str
    The provider-assigned unique ID for this managed resource.
    metastore_id str
    Unique identifier of parent metastore.
    provisioning_infos Sequence[ConnectionProvisioningInfo]
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    securable_type str
    Securable type.
    updated_at int
    Time at which this connection was updated, in epoch milliseconds.
    updated_by str
    Username of user who last modified connection.
    url str
    URL of the remote data source, extracted from options.
    connectionId String
    Unique identifier of the Connection.
    createdAt Number
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential.
    fullName String
    Full name of connection.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String
    Unique identifier of parent metastore.
    provisioningInfos List<Property Map>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    securableType String
    Securable type.
    updatedAt Number
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy String
    Username of user who last modified connection.
    url String
    URL of the remote data source, extracted from options.

    Look up Existing Connection Resource

    Get an existing Connection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        connection_id: Optional[str] = None,
        connection_type: Optional[str] = None,
        created_at: Optional[int] = None,
        created_by: Optional[str] = None,
        credential_type: Optional[str] = None,
        environment_settings: Optional[ConnectionEnvironmentSettingsArgs] = None,
        full_name: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        provider_config: Optional[ConnectionProviderConfigArgs] = None,
        provisioning_infos: Optional[Sequence[ConnectionProvisioningInfoArgs]] = None,
        read_only: Optional[bool] = None,
        securable_type: Optional[str] = None,
        updated_at: Optional[int] = None,
        updated_by: Optional[str] = None,
        url: Optional[str] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Connection    get:      id: ${id}
    import {
  to = databricks_connection.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Comment string
    User-provided free-form text description. Change forces creation of a new resource.
    ConnectionId string
    Unique identifier of the Connection.
    ConnectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential.
    EnvironmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    FullName string
    Full name of connection.
    MetastoreId string
    Unique identifier of parent metastore.
    Name string
    Name of the connection.
    Options Dictionary<string, string>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    Owner string
    Username of current owner of the connection.
    Properties Dictionary<string, string>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    ProviderConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    ProvisioningInfos List<ConnectionProvisioningInfo>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    ReadOnly bool
    If the connection is read only. Change forces creation of a new resource.
    SecurableType string
    Securable type.
    UpdatedAt int
    Time at which this connection was updated, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified connection.
    Url string
    URL of the remote data source, extracted from options.
    Comment string
    User-provided free-form text description. Change forces creation of a new resource.
    ConnectionId string
    Unique identifier of the Connection.
    ConnectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    CreatedAt int
    Time at which this connection was created, in epoch milliseconds.
    CreatedBy string
    Username of connection creator.
    CredentialType string
    The type of credential.
    EnvironmentSettings ConnectionEnvironmentSettingsArgs
    Connection environment settings. This block consists of the following fields:
    FullName string
    Full name of connection.
    MetastoreId string
    Unique identifier of parent metastore.
    Name string
    Name of the connection.
    Options map[string]string
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    Owner string
    Username of current owner of the connection.
    Properties map[string]string
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    ProviderConfig ConnectionProviderConfigArgs
    Configure the provider for management through account provider. This block consists of the following fields:
    ProvisioningInfos []ConnectionProvisioningInfoArgs
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    ReadOnly bool
    If the connection is read only. Change forces creation of a new resource.
    SecurableType string
    Securable type.
    UpdatedAt int
    Time at which this connection was updated, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified connection.
    Url string
    URL of the remote data source, extracted from options.
    comment string
    User-provided free-form text description. Change forces creation of a new resource.
    connection_id string
    Unique identifier of the Connection.
    connection_type string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    created_at number
    Time at which this connection was created, in epoch milliseconds.
    created_by string
    Username of connection creator.
    credential_type string
    The type of credential.
    environment_settings object
    Connection environment settings. This block consists of the following fields:
    full_name string
    Full name of connection.
    metastore_id string
    Unique identifier of parent metastore.
    name string
    Name of the connection.
    options map(string)
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner string
    Username of current owner of the connection.
    properties map(string)
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    provider_config object
    Configure the provider for management through account provider. This block consists of the following fields:
    provisioning_infos list(object)
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    read_only bool
    If the connection is read only. Change forces creation of a new resource.
    securable_type string
    Securable type.
    updated_at number
    Time at which this connection was updated, in epoch milliseconds.
    updated_by string
    Username of user who last modified connection.
    url string
    URL of the remote data source, extracted from options.
    comment String
    User-provided free-form text description. Change forces creation of a new resource.
    connectionId String
    Unique identifier of the Connection.
    connectionType String
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    createdAt Integer
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential.
    environmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    fullName String
    Full name of connection.
    metastoreId String
    Unique identifier of parent metastore.
    name String
    Name of the connection.
    options Map<String,String>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner String
    Username of current owner of the connection.
    properties Map<String,String>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    provisioningInfos List<ConnectionProvisioningInfo>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    readOnly Boolean
    If the connection is read only. Change forces creation of a new resource.
    securableType String
    Securable type.
    updatedAt Integer
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy String
    Username of user who last modified connection.
    url String
    URL of the remote data source, extracted from options.
    comment string
    User-provided free-form text description. Change forces creation of a new resource.
    connectionId string
    Unique identifier of the Connection.
    connectionType string
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    createdAt number
    Time at which this connection was created, in epoch milliseconds.
    createdBy string
    Username of connection creator.
    credentialType string
    The type of credential.
    environmentSettings ConnectionEnvironmentSettings
    Connection environment settings. This block consists of the following fields:
    fullName string
    Full name of connection.
    metastoreId string
    Unique identifier of parent metastore.
    name string
    Name of the connection.
    options {[key: string]: string}
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner string
    Username of current owner of the connection.
    properties {[key: string]: string}
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig ConnectionProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    provisioningInfos ConnectionProvisioningInfo[]
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    readOnly boolean
    If the connection is read only. Change forces creation of a new resource.
    securableType string
    Securable type.
    updatedAt number
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy string
    Username of user who last modified connection.
    url string
    URL of the remote data source, extracted from options.
    comment str
    User-provided free-form text description. Change forces creation of a new resource.
    connection_id str
    Unique identifier of the Connection.
    connection_type str
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    created_at int
    Time at which this connection was created, in epoch milliseconds.
    created_by str
    Username of connection creator.
    credential_type str
    The type of credential.
    environment_settings ConnectionEnvironmentSettingsArgs
    Connection environment settings. This block consists of the following fields:
    full_name str
    Full name of connection.
    metastore_id str
    Unique identifier of parent metastore.
    name str
    Name of the connection.
    options Mapping[str, str]
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner str
    Username of current owner of the connection.
    properties Mapping[str, str]
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    provider_config ConnectionProviderConfigArgs
    Configure the provider for management through account provider. This block consists of the following fields:
    provisioning_infos Sequence[ConnectionProvisioningInfoArgs]
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    read_only bool
    If the connection is read only. Change forces creation of a new resource.
    securable_type str
    Securable type.
    updated_at int
    Time at which this connection was updated, in epoch milliseconds.
    updated_by str
    Username of user who last modified connection.
    url str
    URL of the remote data source, extracted from options.
    comment String
    User-provided free-form text description. Change forces creation of a new resource.
    connectionId String
    Unique identifier of the Connection.
    connectionType String
    The type of connection. Possible values are: BIGQUERY, CONFLUENCE, DATABRICKS, GA4_RAW_DATA, GITHUB, GLUE, HIVE_METASTORE, HTTP, HUBSPOT, META_MARKETING, MYSQL, ORACLE, OUTLOOK, POSTGRESQL, POWER_BI, REDSHIFT, SALESFORCE, SALESFORCE_DATA_CLOUD, SERVICENOW, SMARTSHEET, SNOWFLAKE, SQLDW, SQLSERVER, TERADATA, WORKDAY_RAAS, or ZENDESK. For an up-to-date list of connection types and required options, see the documentation. Change forces creation of a new resource.
    createdAt Number
    Time at which this connection was created, in epoch milliseconds.
    createdBy String
    Username of connection creator.
    credentialType String
    The type of credential.
    environmentSettings Property Map
    Connection environment settings. This block consists of the following fields:
    fullName String
    Full name of connection.
    metastoreId String
    Unique identifier of parent metastore.
    name String
    Name of the connection.
    options Map<String>
    A map of key-value properties attached to the securable. The required keys depend on the connection type, e.g. host, port, user, password, authorizationEndpoint, clientId, clientSecret, or GoogleServiceAccountKeyJson. Please consult the documentation for the required options. This field is sensitive.
    owner String
    Username of current owner of the connection.
    properties Map<String>
    A map of key-value properties attached to the securable. Change forces creation of a new resource.
    providerConfig Property Map
    Configure the provider for management through account provider. This block consists of the following fields:
    provisioningInfos List<Property Map>
    Status of an asynchronously provisioned resource. This block consists of the following fields:
    readOnly Boolean
    If the connection is read only. Change forces creation of a new resource.
    securableType String
    Securable type.
    updatedAt Number
    Time at which this connection was updated, in epoch milliseconds.
    updatedBy String
    Username of user who last modified connection.
    url String
    URL of the remote data source, extracted from options.

    Supporting Types

    ConnectionEnvironmentSettings, ConnectionEnvironmentSettingsArgs

    EnvironmentVersion string
    Environment version.
    JavaDependencies List<string>
    List of Java dependencies.
    EnvironmentVersion string
    Environment version.
    JavaDependencies []string
    List of Java dependencies.
    environment_version string
    Environment version.
    java_dependencies list(string)
    List of Java dependencies.
    environmentVersion String
    Environment version.
    javaDependencies List<String>
    List of Java dependencies.
    environmentVersion string
    Environment version.
    javaDependencies string[]
    List of Java dependencies.
    environment_version str
    Environment version.
    java_dependencies Sequence[str]
    List of Java dependencies.
    environmentVersion String
    Environment version.
    javaDependencies List<String>
    List of Java dependencies.

    ConnectionProviderConfig, ConnectionProviderConfigArgs

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    ConnectionProvisioningInfo, ConnectionProvisioningInfoArgs

    State string
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    State string
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    state string
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    state String
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    state string
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    state str
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.
    state String
    The provisioning state of the resource. Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, or UPDATING.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.96.0
    published on Thursday, Jun 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial