knowledge_assistant_permissions

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

Overview

Name	knowledge_assistant_permissions
Type	Resource
Id	databricks_workspace.knowledgeassistants.knowledge_assistant_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	knowledge_assistant_id, deployment_name, workspace_domain		Gets the permissions of a knowledge assistant. Knowledge assistants can inherit permissions from their
update	update	knowledge_assistant_id, deployment_name, workspace_domain		Updates the permissions on a knowledge assistant. Knowledge assistants can inherit permissions from
set	replace	knowledge_assistant_id, deployment_name, workspace_domain		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: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
knowledge_assistant_id	string	The knowledge assistant for which to get or manage permissions.
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})

SELECT examples

get

Gets the permissions of a knowledge assistant. Knowledge assistants can inherit permissions from their

SELECT
object_id,
access_control_list,
object_type
FROM databricks_workspace.knowledgeassistants.knowledge_assistant_permissions
WHERE knowledge_assistant_id = '{{ knowledge_assistant_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

UPDATE examples

update

Updates the permissions on a knowledge assistant. Knowledge assistants can inherit permissions from

UPDATE databricks_workspace.knowledgeassistants.knowledge_assistant_permissions
SET 
access_control_list = '{{ access_control_list }}'
WHERE 
knowledge_assistant_id = '{{ knowledge_assistant_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --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.knowledgeassistants.knowledge_assistant_permissions
SET 
access_control_list = '{{ access_control_list }}'
WHERE 
knowledge_assistant_id = '{{ knowledge_assistant_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
RETURNING
object_id,
access_control_list,
object_type;