azure.databricks.WorkspaceCustomerManagedKey

Azure v6.33.0, Feb 23 26

We recommend using Azure Native.

Viewing docs for Azure v6.33.0
published on Monday, Feb 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v6.33.0
published on Monday, Feb 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleWorkspace = new azure.databricks.Workspace("example", {
    name: "databricks-test",
    resourceGroupName: example.name,
    location: example.location,
    sku: "standard",
    tags: {
        Environment: "Production",
    },
});

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_workspace = azure.databricks.Workspace("example",
    name="databricks-test",
    resource_group_name=example.name,
    location=example.location,
    sku="standard",
    tags={
        "Environment": "Production",
    })

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewWorkspace(ctx, "example", &databricks.WorkspaceArgs{
			Name:              pulumi.String("databricks-test"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku:               pulumi.String("standard"),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleWorkspace = new Azure.DataBricks.Workspace("example", new()
    {
        Name = "databricks-test",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
        Tags = 
        {
            { "Environment", "Production" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.databricks.Workspace;
import com.pulumi.azure.databricks.WorkspaceArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("databricks-test")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .tags(Map.of("Environment", "Production"))
            .build());

    }
}

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleWorkspace:
    type: azure:databricks:Workspace
    name: example
    properties:
      name: databricks-test
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard
      tags:
        Environment: Production

Note: You can use the Databricks Terraform Provider to manage resources within the Databricks Workspace.

Example HCL Configurations

Databricks Workspace Secure Connectivity Cluster with Load Balancer
Databricks Workspace Secure Connectivity Cluster without Load Balancer
Databricks Workspace with Private Endpoint
Databricks Workspace with Private Endpoint, Customer Managed Keys for Managed Services and Databricks File System Customer Managed Keys
Databricks Workspace with Root Databricks File System Customer Managed Keys
Databricks Workspace with Root Databricks File System Customer Managed Keys in a Different Subscription
Databricks Workspace with Customer Managed Keys for Managed Services
Databricks Workspace with Customer Managed Keys for Managed Services with Key Vault and Key in a Different Subscription

API Providers

This resource uses the following Azure API Providers:

Microsoft.Databricks - 2024-05-01, 2022-10-01-preview
Microsoft.Network - 2025-01-01, 2023-09-01

Create WorkspaceCustomerManagedKey Resource

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

Constructor syntax

new WorkspaceCustomerManagedKey(name: string, args: WorkspaceCustomerManagedKeyArgs, opts?: CustomResourceOptions);

@overload
def WorkspaceCustomerManagedKey(resource_name: str,
                                args: WorkspaceCustomerManagedKeyArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceCustomerManagedKey(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                key_vault_key_id: Optional[str] = None,
                                workspace_id: Optional[str] = None)

func NewWorkspaceCustomerManagedKey(ctx *Context, name string, args WorkspaceCustomerManagedKeyArgs, opts ...ResourceOption) (*WorkspaceCustomerManagedKey, error)

public WorkspaceCustomerManagedKey(string name, WorkspaceCustomerManagedKeyArgs args, CustomResourceOptions? opts = null)

public WorkspaceCustomerManagedKey(String name, WorkspaceCustomerManagedKeyArgs args)
public WorkspaceCustomerManagedKey(String name, WorkspaceCustomerManagedKeyArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args WorkspaceCustomerManagedKeyArgs: 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 WorkspaceCustomerManagedKeyArgs: 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 WorkspaceCustomerManagedKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkspaceCustomerManagedKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkspaceCustomerManagedKeyArgs: 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 workspaceCustomerManagedKeyResource = new Azure.DataBricks.WorkspaceCustomerManagedKey("workspaceCustomerManagedKeyResource", new()
{
    KeyVaultKeyId = "string",
    WorkspaceId = "string",
});

example, err := databricks.NewWorkspaceCustomerManagedKey(ctx, "workspaceCustomerManagedKeyResource", &databricks.WorkspaceCustomerManagedKeyArgs{
	KeyVaultKeyId: pulumi.String("string"),
	WorkspaceId:   pulumi.String("string"),
})

var workspaceCustomerManagedKeyResource = new WorkspaceCustomerManagedKey("workspaceCustomerManagedKeyResource", WorkspaceCustomerManagedKeyArgs.builder()
    .keyVaultKeyId("string")
    .workspaceId("string")
    .build());

workspace_customer_managed_key_resource = azure.databricks.WorkspaceCustomerManagedKey("workspaceCustomerManagedKeyResource",
    key_vault_key_id="string",
    workspace_id="string")

const workspaceCustomerManagedKeyResource = new azure.databricks.WorkspaceCustomerManagedKey("workspaceCustomerManagedKeyResource", {
    keyVaultKeyId: "string",
    workspaceId: "string",
});

type: azure:databricks:WorkspaceCustomerManagedKey
properties:
    keyVaultKeyId: string
    workspaceId: string

WorkspaceCustomerManagedKey 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 WorkspaceCustomerManagedKey resource accepts the following input properties:

KeyVaultKeyId string
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

KeyVaultKeyId string
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId String
workspaceId String: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId string
workspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

key_vault_key_id str
workspace_id str: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId String
workspaceId String: The unique identifier of the databricks workspace in Databricks control plane.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing WorkspaceCustomerManagedKey Resource

Get an existing WorkspaceCustomerManagedKey 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?: WorkspaceCustomerManagedKeyState, opts?: CustomResourceOptions): WorkspaceCustomerManagedKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key_vault_key_id: Optional[str] = None,
        workspace_id: Optional[str] = None) -> WorkspaceCustomerManagedKey

func GetWorkspaceCustomerManagedKey(ctx *Context, name string, id IDInput, state *WorkspaceCustomerManagedKeyState, opts ...ResourceOption) (*WorkspaceCustomerManagedKey, error)

public static WorkspaceCustomerManagedKey Get(string name, Input<string> id, WorkspaceCustomerManagedKeyState? state, CustomResourceOptions? opts = null)

public static WorkspaceCustomerManagedKey get(String name, Output<String> id, WorkspaceCustomerManagedKeyState state, CustomResourceOptions options)

resources:  _:    type: azure:databricks:WorkspaceCustomerManagedKey    get:      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:

KeyVaultKeyId string
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

KeyVaultKeyId string
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId String
workspaceId String: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId string
workspaceId string: The unique identifier of the databricks workspace in Databricks control plane.

key_vault_key_id str
workspace_id str: The unique identifier of the databricks workspace in Databricks control plane.

keyVaultKeyId String
workspaceId String: The unique identifier of the databricks workspace in Databricks control plane.

Import

Databrick Workspaces can be imported using the resource id, e.g.

$ pulumi import azure:databricks/workspaceCustomerManagedKey:WorkspaceCustomerManagedKey workspace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Databricks/workspaces/workspace1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Viewing docs for Azure v6.33.0
published on Monday, Feb 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure

azure.databricks.WorkspaceCustomerManagedKey

On this page

On this page

Example Usage

Example HCL Configurations

API Providers

Create WorkspaceCustomerManagedKey Resource

Constructor syntax

Parameters

Constructor example

WorkspaceCustomerManagedKey Resource Properties

Inputs

Outputs

Look up Existing WorkspaceCustomerManagedKey Resource

Import

Package Details

On this page

On this page