provider_provider_analytics_dashboards

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

Overview

Name	provider_provider_analytics_dashboards
Type	Resource
Id	databricks_workspace.marketplace.provider_provider_analytics_dashboards

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
dashboard_id	string	dashboard_id will be used to open Lakeview dashboard.
version	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name, workspace_domain		Get provider analytics dashboard.
create	insert	deployment_name, workspace_domain		Create provider analytics dashboard. Returns Marketplace specific id. Not to be confused with the
update	replace	id, deployment_name, workspace_domain		Update provider analytics dashboard.
get_latest_version	exec	deployment_name, workspace_domain		Get latest version of provider analytics dashboard.

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)
id	string	id is immutable property and can't be updated.
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

Get provider analytics dashboard.

SELECT
id,
dashboard_id,
version
FROM databricks_workspace.marketplace.provider_provider_analytics_dashboards
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

INSERT examples

create

Create provider analytics dashboard. Returns Marketplace specific id. Not to be confused with the

INSERT INTO databricks_workspace.marketplace.provider_provider_analytics_dashboards (
deployment_name,
workspace_domain
)
SELECT 
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: provider_provider_analytics_dashboards
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_provider_analytics_dashboards resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the provider_provider_analytics_dashboards resource.

REPLACE examples

update

Update provider analytics dashboard.

REPLACE databricks_workspace.marketplace.provider_provider_analytics_dashboards
SET 
version = {{ version }}
WHERE 
id = '{{ id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
RETURNING
id,
dashboard_id,
version;

Lifecycle Methods

get_latest_version

Get latest version of provider analytics dashboard.

EXEC databricks_workspace.marketplace.provider_provider_analytics_dashboards.get_latest_version 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required
;