Workspace

Manages a Databricks Workspace

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleWorkspace = new Azure.DataBricks.Workspace("exampleWorkspace", new Azure.DataBricks.WorkspaceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = "standard",
            Tags = 
            {
                { "Environment", "Production" },
            },
        });
    }

}

package main

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

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_workspace = azure.databricks.Workspace("exampleWorkspace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku="standard",
    tags={
        "Environment": "Production",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleWorkspace = new azure.databricks.Workspace("exampleWorkspace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: "standard",
    tags: {
        Environment: "Production",
    },
});

Create a Workspace Resource

new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);

def Workspace(resource_name, opts=None, custom_parameters=None, location=None, managed_resource_group_name=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None);

func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)

public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WorkspaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Workspace Resource Properties

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

Inputs

The Workspace resource accepts the following input properties:

ResourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
Sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
CustomParameters WorkspaceCustomParametersArgs: A custom_parameters block as documented below.
Location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
ManagedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
Name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
Sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
CustomParameters WorkspaceCustomParameters: A custom_parameters block as documented below.
Location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
ManagedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
Name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
customParameters WorkspaceCustomParameters: A custom_parameters block as documented below.
location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
managedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
sku str: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
custom_parameters Dict[WorkspaceCustomParameters]: A custom_parameters block as documented below.
location str: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
managed_resource_group_name str: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
name str: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
ManagedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
WorkspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

Id string: The provider-assigned unique ID for this managed resource.
ManagedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
WorkspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

id string: The provider-assigned unique ID for this managed resource.
managedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
workspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
workspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

id str: The provider-assigned unique ID for this managed resource.
managed_resource_group_id str: The ID of the Managed Resource Group created by the Databricks Workspace.
workspace_id str: The unique identifier of the databricks workspace in Databricks control plane.
workspace_url str: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

Look up an Existing Workspace Resource

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

static get(resource_name, id, opts=None, custom_parameters=None, location=None, managed_resource_group_id=None, managed_resource_group_name=None, name=None, resource_group_name=None, sku=None, tags=None, workspace_id=None, workspace_url=None, __props__=None);

func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)

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

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.

The following state arguments are supported:

CustomParameters WorkspaceCustomParametersArgs: A custom_parameters block as documented below.
Location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
ManagedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
ManagedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
Name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
Sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
WorkspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

CustomParameters WorkspaceCustomParameters: A custom_parameters block as documented below.
Location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
ManagedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
ManagedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
Name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
Sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
WorkspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
WorkspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

customParameters WorkspaceCustomParameters: A custom_parameters block as documented below.
location string: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
managedResourceGroupId string: The ID of the Managed Resource Group created by the Databricks Workspace.
managedResourceGroupName string: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
name string: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
sku string: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
workspaceId string: The unique identifier of the databricks workspace in Databricks control plane.
workspaceUrl string: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

custom_parameters Dict[WorkspaceCustomParameters]: A custom_parameters block as documented below.
location str: Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
managed_resource_group_id str: The ID of the Managed Resource Group created by the Databricks Workspace.
managed_resource_group_name str: The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
name str: Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
sku str: The sku to use for the Databricks Workspace. Possible values are standard, premium, or trial. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
workspace_id str: The unique identifier of the databricks workspace in Databricks control plane.
workspace_url str: The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

Supporting Types

WorkspaceCustomParameters

See the input and output API doc for this type.

NoPublicIp bool: Are public IP Addresses not allowed?
PrivateSubnetName string: The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.
PublicSubnetName string: The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.
VirtualNetworkId string: The ID of a Virtual Network where this Databricks Cluster should be created.

NoPublicIp bool: Are public IP Addresses not allowed?
PrivateSubnetName string: The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.
PublicSubnetName string: The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.
VirtualNetworkId string: The ID of a Virtual Network where this Databricks Cluster should be created.

noPublicIp boolean: Are public IP Addresses not allowed?
privateSubnetName string: The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.
publicSubnetName string: The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.
virtualNetworkId string: The ID of a Virtual Network where this Databricks Cluster should be created.

noPublicIp bool: Are public IP Addresses not allowed?
privateSubnetName str: The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.
publicSubnetName str: The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.
virtual_network_id str: The ID of a Virtual Network where this Databricks Cluster should be created.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud