provider_shares

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

Overview

Name	provider_shares
Type	Resource
Id	databricks_workspace.sharing.provider_shares

Fields

The following fields are returned by SELECT queries:

list_shares

Name	Datatype	Description
name	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_shares	select	name, deployment_name	max_results, page_token	Gets an array of a specified provider's shares within the metastore where:

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)
name	string	Name of the provider in which to list shares.
max_results	integer	Maximum number of shares to return. - when set to 0, the page length is set to a server configured value (recommended); - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to a value less than 0, an invalid parameter error is returned; - If not set, all valid shares are returned (not recommended). - Note: The number of returned shares might be less than the specified max_results size, even zero. The only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.
page_token	string	Opaque pagination token to go to next page based on previous query.

SELECT examples

list_shares

Gets an array of a specified provider's shares within the metastore where:

SELECT
name
FROM databricks_workspace.sharing.provider_shares
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;