dashboard_subscriptions

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

Overview

Name	dashboard_subscriptions
Type	Resource
Id	databricks_workspace.lakeview.dashboard_subscriptions

Fields

The following fields are returned by SELECT queries:

getsubscription

Request completed successfully.

Name	Datatype	Description
created_by_user_id	string
dashboard_id	string
schedule_id	string
subscription_id	string
create_time	string
etag	string
subscriber	object
update_time	string

listsubscriptions

Request completed successfully.

Name	Datatype	Description
created_by_user_id	string
dashboard_id	string
schedule_id	string
subscription_id	string
create_time	string
etag	string
subscriber	object
update_time	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getsubscription	select	deployment_name
listsubscriptions	select	deployment_name
createsubscription	insert	deployment_name
deletesubscription	delete	deployment_name

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

getsubscription

Request completed successfully.

SELECT
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
FROM databricks_workspace.lakeview.dashboard_subscriptions
WHERE deployment_name = '{{ deployment_name }}' -- required;

listsubscriptions

Request completed successfully.

SELECT
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
FROM databricks_workspace.lakeview.dashboard_subscriptions
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createsubscription

No description available.

INSERT INTO databricks_workspace.lakeview.dashboard_subscriptions (
data__etag,
data__subscriber,
deployment_name
)
SELECT 
'{{ etag }}',
'{{ subscriber }}',
'{{ deployment_name }}'
RETURNING
created_by_user_id,
dashboard_id,
schedule_id,
subscription_id,
create_time,
etag,
subscriber,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: dashboard_subscriptions
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the dashboard_subscriptions resource.
    - name: etag
      value: string
    - name: subscriber
      value: required

DELETE examples

deletesubscription

No description available.

DELETE FROM databricks_workspace.lakeview.dashboard_subscriptions
WHERE deployment_name = '{{ deployment_name }}' --required;