consumer_providers

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

Overview

Name	consumer_providers
Type	Resource
Id	databricks_workspace.marketplace.consumer_providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶provider	object

list

Name	Datatype	Description
id	string
name	string
dark_mode_icon_file_id	string
icon_file_id	string
business_contact_email	string
company_website_link	string
dark_mode_icon_file_path	string
description	string
icon_file_path	string
is_featured	boolean	is_featured is accessible by consumers only
privacy_policy_link	string
published_by	string	published_by is only applicable to data aggregators (e.g. Crux)
support_contact_email	string
term_of_service_link	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, deployment_name, workspace_domain		Get a provider in the Databricks Marketplace with at least one visible listing.
list	select	deployment_name, workspace_domain	is_featured, page_size, page_token	List all providers in the Databricks Marketplace with at least one visible listing.
batch_get	exec	deployment_name, workspace_domain	ids	Batch get a provider in the Databricks Marketplace with at least one visible listing.

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
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"}})
ids	array
is_featured	boolean
page_size	integer
page_token	string

SELECT examples

get

Get a provider in the Databricks Marketplace with at least one visible listing.

SELECT
provider
FROM databricks_workspace.marketplace.consumer_providers
WHERE id = '{{ id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

List all providers in the Databricks Marketplace with at least one visible listing.

SELECT
id,
name,
dark_mode_icon_file_id,
icon_file_id,
business_contact_email,
company_website_link,
dark_mode_icon_file_path,
description,
icon_file_path,
is_featured,
privacy_policy_link,
published_by,
support_contact_email,
term_of_service_link
FROM databricks_workspace.marketplace.consumer_providers
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND is_featured = '{{ is_featured }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

Lifecycle Methods

batch_get

Batch get a provider in the Databricks Marketplace with at least one visible listing.

EXEC databricks_workspace.marketplace.consumer_providers.batch_get 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required, 
@ids='{{ ids }}'
;