1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. databricks

Module databricks

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource Workspace

class Workspace extends CustomResource

Manages a Databricks Workspace

Example Usage

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",
    },
});

constructor

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

Create a Workspace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkspaceState, opts?: pulumi.CustomResourceOptions): Workspace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Workspace

Returns true if the given object is an instance of Workspace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property customParameters

public customParameters: pulumi.Output<WorkspaceCustomParameters>;

A customParameters block as documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.

property managedResourceGroupId

public managedResourceGroupId: pulumi.Output<string>;

The ID of the Managed Resource Group created by the Databricks Workspace.

property managedResourceGroupName

public managedResourceGroupName: pulumi.Output<string>;

The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.

property sku

public sku: pulumi.Output<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.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workspaceId

public workspaceId: pulumi.Output<string>;

The unique identifier of the databricks workspace in Databricks control plane.

property workspaceUrl

public workspaceUrl: pulumi.Output<string>;

The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

Others

interface WorkspaceArgs

interface WorkspaceArgs

The set of arguments for constructing a Workspace resource.

property customParameters

customParameters?: pulumi.Input<WorkspaceCustomParameters>;

A customParameters block as documented below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.

property managedResourceGroupName

managedResourceGroupName?: pulumi.Input<string>;

The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface WorkspaceState

interface WorkspaceState

Input properties used for looking up and filtering Workspace resources.

property customParameters

customParameters?: pulumi.Input<WorkspaceCustomParameters>;

A customParameters block as documented below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.

property managedResourceGroupId

managedResourceGroupId?: pulumi.Input<string>;

The ID of the Managed Resource Group created by the Databricks Workspace.

property managedResourceGroupName

managedResourceGroupName?: pulumi.Input<string>;

The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property workspaceId

workspaceId?: pulumi.Input<string>;

The unique identifier of the databricks workspace in Databricks control plane.

property workspaceUrl

workspaceUrl?: pulumi.Input<string>;

The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’