workspace_bindings

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

Overview

Name	workspace_bindings
Type	Resource
Id	databricks_workspace.unitycatalog.workspace_bindings

Fields

The following fields are returned by SELECT queries:

getbindings

A list of workspace IDs that are bound to the securable

Name	Datatype	Description
workspace_id	integer
binding_type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getbindings	select	deployment_name		Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.
update	update	deployment_name		Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.
updatebindings	update	deployment_name		Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

getbindings

Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

SELECT
workspace_id,
binding_type
FROM databricks_workspace.unitycatalog.workspace_bindings
WHERE deployment_name = '{{ deployment_name }}' -- required;

UPDATE examples

update

Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.

UPDATE databricks_workspace.unitycatalog.workspace_bindings
SET 
data__assign_workspaces = '{{ assign_workspaces }}',
data__unassign_workspaces = '{{ unassign_workspaces }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
workspaces;

updatebindings

Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

UPDATE databricks_workspace.unitycatalog.workspace_bindings
SET 
data__add = '{{ add }}',
data__remove = '{{ remove }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
bindings,
next_page_token;