object_permissions

Creates, updates, deletes, gets or lists an object_permissions resource.

Overview

Name	object_permissions
Type	Resource
Id	databricks_workspace.workspace.object_permissions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
object_id	string
▶access_control_list	array
object_type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspace_object_type, workspace_object_id, deployment_name		Gets the permissions of a workspace object. Workspace objects can inherit permissions from their
update	update	workspace_object_type, workspace_object_id, deployment_name		Updates the permissions on a workspace object. Workspace objects can inherit permissions from their
set	replace	workspace_object_type, workspace_object_id, deployment_name		Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct

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)
workspace_object_id	string	The workspace object for which to get or manage permissions.
workspace_object_type	string	The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries

SELECT examples

get

Gets the permissions of a workspace object. Workspace objects can inherit permissions from their

SELECT
object_id,
access_control_list,
object_type
FROM databricks_workspace.workspace.object_permissions
WHERE workspace_object_type = '{{ workspace_object_type }}' -- required
AND workspace_object_id = '{{ workspace_object_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

UPDATE examples

update

Updates the permissions on a workspace object. Workspace objects can inherit permissions from their

UPDATE databricks_workspace.workspace.object_permissions
SET 
access_control_list = '{{ access_control_list }}'
WHERE 
workspace_object_type = '{{ workspace_object_type }}' --required
AND workspace_object_id = '{{ workspace_object_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
RETURNING
object_id,
access_control_list,
object_type;

REPLACE examples

set

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct

REPLACE databricks_workspace.workspace.object_permissions
SET 
access_control_list = '{{ access_control_list }}'
WHERE 
workspace_object_type = '{{ workspace_object_type }}' --required
AND workspace_object_id = '{{ workspace_object_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
RETURNING
object_id,
access_control_list,
object_type;