workspaces

Creates, updates, deletes, gets or lists a workspaces resource.

Overview

Name	workspaces
Type	Resource
Id	databricks_account.provisioning.workspaces

Fields

The following fields are returned by SELECT queries:

get

The workspace configuration was successfully returned.

Name	Datatype	Description
account_id	string
credentials_id	string
managed_services_customer_managed_key_id	string
network_id	string
private_access_settings_id	string
storage_configuration_id	string
storage_customer_managed_key_id	string
workspace_id	integer
deployment_name	string
workspace_name	string
aws_region	string
creation_time	integer
custom_tags	object
is_no_public_ip_enabled	boolean
pricing_tier	string
workspace_status	string
workspace_status_message	string

list

The workspaces were returned successfully.

Name	Datatype	Description
account_id	string
credentials_id	string
managed_services_customer_managed_key_id	string
network_id	string
private_access_settings_id	string
storage_configuration_id	string
storage_customer_managed_key_id	string
workspace_id	integer
deployment_name	string
workspace_name	string
aws_region	string
creation_time	integer
custom_tags	object
is_no_public_ip_enabled	boolean
pricing_tier	string
workspace_status	string
workspace_status_message	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets information including status for a Databricks workspace, specified by ID. In the response, the
list	select			Gets a list of all workspaces associated with an account, specified by ID.
create	insert			Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.
update	update			Updates a workspace configuration for either a running workspace or a failed workspace. The elements that can be updated varies between these two use cases.
delete	delete			Terminates and deletes a Databricks workspace. From an API perspective, deletion is immediate. However, it might take a few minutes for all workspaces resources to be deleted, depending on the size and number of workspace resources.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

SELECT examples

get

Gets information including status for a Databricks workspace, specified by ID. In the response, the

SELECT
account_id,
credentials_id,
managed_services_customer_managed_key_id,
network_id,
private_access_settings_id,
storage_configuration_id,
storage_customer_managed_key_id,
workspace_id,
deployment_name,
workspace_name,
aws_region,
creation_time,
custom_tags,
is_no_public_ip_enabled,
pricing_tier,
workspace_status,
workspace_status_message
FROM databricks_account.provisioning.workspaces;

list

Gets a list of all workspaces associated with an account, specified by ID.

SELECT
account_id,
credentials_id,
managed_services_customer_managed_key_id,
network_id,
private_access_settings_id,
storage_configuration_id,
storage_customer_managed_key_id,
workspace_id,
deployment_name,
workspace_name,
aws_region,
creation_time,
custom_tags,
is_no_public_ip_enabled,
pricing_tier,
workspace_status,
workspace_status_message
FROM databricks_account.provisioning.workspaces;

INSERT examples

create

Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.

INSERT INTO databricks_account.provisioning.workspaces (
data__workspace_name,
data__network_id,
data__deployment_name,
data__aws_region,
data__credentials_id,
data__storage_configuration_id,
data__managed_services_customer_managed_key_id,
data__private_access_settings_id,
data__pricing_tier,
data__storage_customer_managed_key_id,
data__custom_tags
)
SELECT 
'{{ workspace_name }}',
'{{ network_id }}',
'{{ deployment_name }}',
'{{ aws_region }}',
'{{ credentials_id }}',
'{{ storage_configuration_id }}',
'{{ managed_services_customer_managed_key_id }}',
'{{ private_access_settings_id }}',
'{{ pricing_tier }}',
'{{ storage_customer_managed_key_id }}',
'{{ custom_tags }}'
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: workspace_name
      value: required
    - name: network_id
      value: string
    - name: deployment_name
      value: uuid
    - name: aws_region
      value: string
    - name: credentials_id
      value: string
    - name: storage_configuration_id
      value: uuid
    - name: managed_services_customer_managed_key_id
      value: uuid
    - name: private_access_settings_id
      value: uuid
    - name: pricing_tier
      value: uuid
    - name: storage_customer_managed_key_id
      value: string
    - name: custom_tags
      value: object

UPDATE examples

update

Updates a workspace configuration for either a running workspace or a failed workspace. The elements that can be updated varies between these two use cases.

UPDATE databricks_account.provisioning.workspaces
SET 
data__aws_region = '{{ aws_region }}',
data__credentials_id = '{{ credentials_id }}',
data__storage_configuration_id = '{{ storage_configuration_id }}',
data__network_id = '{{ network_id }}',
data__managed_services_customer_managed_key_id = '{{ managed_services_customer_managed_key_id }}',
data__private_access_settings_id = '{{ private_access_settings_id }}',
data__storage_customer_managed_key_id = '{{ storage_customer_managed_key_id }}',
data__network_connectivity_config_id = '{{ network_connectivity_config_id }}',
data__custom_tags = '{{ custom_tags }}'
WHERE 
;

DELETE examples

delete

Terminates and deletes a Databricks workspace. From an API perspective, deletion is immediate. However, it might take a few minutes for all workspaces resources to be deleted, depending on the size and number of workspace resources.

DELETE FROM databricks_account.provisioning.workspaces;