provider_providers

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

Overview

Name	provider_providers
Type	Resource
Id	databricks_workspace.marketplace.provider_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		Get provider profile
list	select	deployment_name	page_size, page_token	List provider profiles for account.
create	insert	deployment_name, provider		Create a provider
update	replace	id, deployment_name, provider		Update provider profile
delete	delete	id, deployment_name		Delete provider

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)
id	string	str
page_size	integer	:param page_token: str (optional)
page_token	string

SELECT examples

get

Get provider profile

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

list

List provider profiles for account.

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.provider_providers
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a provider

INSERT INTO databricks_workspace.marketplace.provider_providers (
provider,
deployment_name
)
SELECT 
'{{ provider }}' /* required */,
'{{ deployment_name }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: provider_providers
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_providers resource.
  - name: provider
    description: |
      :returns: :class:`CreateProviderResponse`
    value:
      name: "{{ name }}"
      business_contact_email: "{{ business_contact_email }}"
      term_of_service_link: "{{ term_of_service_link }}"
      privacy_policy_link: "{{ privacy_policy_link }}"
      company_website_link: "{{ company_website_link }}"
      dark_mode_icon_file_id: "{{ dark_mode_icon_file_id }}"
      dark_mode_icon_file_path: "{{ dark_mode_icon_file_path }}"
      description: "{{ description }}"
      icon_file_id: "{{ icon_file_id }}"
      icon_file_path: "{{ icon_file_path }}"
      id: "{{ id }}"
      is_featured: {{ is_featured }}
      published_by: "{{ published_by }}"
      support_contact_email: "{{ support_contact_email }}"

REPLACE examples

update

Update provider profile

REPLACE databricks_workspace.marketplace.provider_providers
SET 
provider = '{{ provider }}'
WHERE 
id = '{{ id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND provider = '{{ provider }}' --required
RETURNING
provider;

DELETE examples

delete

Delete provider

DELETE FROM databricks_workspace.marketplace.provider_providers
WHERE id = '{{ id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;