lakeview_embedded

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

Overview

Name	lakeview_embedded
Type	Resource
Id	databricks_workspace.dashboards.lakeview_embedded

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶authorization_details	array
custom_claim	string	Custom claim generated from external_value and external_viewer_id. Format: `urn:aibi:external_data:<external_value>:<external_viewer_id>:<dashboard_id>`
scope	string	Scope defining access permissions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dashboard_id, deployment_name	external_value, external_viewer_id	Get a required authorization details and scopes of a published dashboard to mint an OAuth token.

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
dashboard_id	string	UUID identifying the published dashboard.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
external_value	string	Provided external value to be included in the custom claim.
external_viewer_id	string	Provided external viewer id to be included in the custom claim.

SELECT examples

get

Get a required authorization details and scopes of a published dashboard to mint an OAuth token.

SELECT
authorization_details,
custom_claim,
scope
FROM databricks_workspace.dashboards.lakeview_embedded
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND external_value = '{{ external_value }}'
AND external_viewer_id = '{{ external_viewer_id }}'
;