Skip to main content

dashboard_embedding_approved_domains

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

Overview

Namedashboard_embedding_approved_domains
TypeResource
Iddatabricks_workspace.workspace.dashboard_embedding_approved_domains

Fields

The following fields are returned by SELECT queries:

Request completed successfully.

NameDatatypeDescription
setting_namestring
aibi_dashboard_embedding_approved_domainsobject
etagstring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdeployment_nameRetrieves the list of domains approved to host embedded AI/BI dashboards.
updateupdatedeployment_nameUpdates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS.
deletedeletedeployment_nameDelete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list.

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.

NameDatatypeDescription
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

Retrieves the list of domains approved to host embedded AI/BI dashboards.

SELECT
setting_name,
aibi_dashboard_embedding_approved_domains,
etag
FROM databricks_workspace.workspace.dashboard_embedding_approved_domains
WHERE deployment_name = '{{ deployment_name }}' -- required;

UPDATE examples

Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS.

UPDATE databricks_workspace.workspace.dashboard_embedding_approved_domains
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_approved_domains,
etag;

DELETE examples

Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list.

DELETE FROM databricks_workspace.workspace.dashboard_embedding_approved_domains
WHERE deployment_name = '{{ deployment_name }}' --required;