dashboard_embedding_access_policy
Creates, updates, deletes, gets or lists a dashboard_embedding_access_policy resource.
Overview
| Name | dashboard_embedding_access_policy |
| Type | Resource |
| Id | databricks_workspace.workspace.dashboard_embedding_access_policy |
Fields
The following fields are returned by SELECT queries:
- get
Request completed successfully.
| Name | Datatype | Description |
|---|---|---|
setting_name | string | |
aibi_dashboard_embedding_access_policy | object | |
etag | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_name | Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains. | |
update | update | deployment_name | Updates the AI/BI dashboard embedding access policy at the workspace level. | |
delete | delete | deployment_name | Delete the AI/BI dashboard embedding access policy, reverting back to the default. |
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
- get
Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains.
SELECT
setting_name,
aibi_dashboard_embedding_access_policy,
etag
FROM databricks_workspace.workspace.dashboard_embedding_access_policy
WHERE deployment_name = '{{ deployment_name }}' -- required;
UPDATE examples
- update
Updates the AI/BI dashboard embedding access policy at the workspace level.
UPDATE databricks_workspace.workspace.dashboard_embedding_access_policy
SET
data__allow_missing = '{{ allow_missing }}',
data__field_mask = {{ field_mask }},
data__setting = '{{ setting }}'
WHERE
deployment_name = '{{ deployment_name }}' --required
RETURNING
setting_name,
aibi_dashboard_embedding_access_policy,
etag;
DELETE examples
- delete
Delete the AI/BI dashboard embedding access policy, reverting back to the default.
DELETE FROM databricks_workspace.workspace.dashboard_embedding_access_policy
WHERE deployment_name = '{{ deployment_name }}' --required;