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.

databricks

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.databricks.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, __name__=None, __opts__=None)

Manages a Databricks Workspace

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",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_parameters (pulumi.Input[dict]) – A custom_parameters block as documented below.

  • location (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.

  • sku (pulumi.Input[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 (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The custom_parameters object supports the following:

  • noPublicIp (pulumi.Input[bool]) - Are public IP Addresses not allowed?

  • privateSubnetName (pulumi.Input[str]) - The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.

  • publicSubnetName (pulumi.Input[str]) - The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.

  • virtual_network_id (pulumi.Input[str]) - The ID of a Virtual Network where this Databricks Cluster should be created.

custom_parameters: pulumi.Output[dict] = None

A custom_parameters block as documented below.

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

location: pulumi.Output[str] = None

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: pulumi.Output[str] = None

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

managed_resource_group_name: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

sku: pulumi.Output[str] = None

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: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

workspace_id: pulumi.Output[str] = None

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

workspace_url: pulumi.Output[str] = None

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

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)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_parameters (pulumi.Input[dict]) – A custom_parameters block as documented below.

  • location (pulumi.Input[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 (pulumi.Input[str]) – The ID of the Managed Resource Group created by the Databricks Workspace.

  • managed_resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.

  • sku (pulumi.Input[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 (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • workspace_id (pulumi.Input[str]) – The unique identifier of the databricks workspace in Databricks control plane.

  • workspace_url (pulumi.Input[str]) – The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’

The custom_parameters object supports the following:

  • noPublicIp (pulumi.Input[bool]) - Are public IP Addresses not allowed?

  • privateSubnetName (pulumi.Input[str]) - The name of the Private Subnet within the Virtual Network. Required if virtual_network_id is set.

  • publicSubnetName (pulumi.Input[str]) - The name of the Public Subnet within the Virtual Network. Required if virtual_network_id is set.

  • virtual_network_id (pulumi.Input[str]) - The ID of a Virtual Network where this Databricks Cluster should be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str