account_user_preferences_metadata

Creates, updates, deletes, gets or lists an account_user_preferences_metadata resource.

Overview

Name	account_user_preferences_metadata
Type	Resource
Id	databricks_account.settingsv2.account_user_preferences_metadata

Fields

The following fields are returned by SELECT queries:

list_account_user_preferences_metadata

Name	Datatype	Description
name	string	Name of the setting.
display_name	string	Human-readable display name for the setting or feature preview. This field may be unset if no display name is available.
description	string
docs_link	string	Link to databricks documentation for the setting
preview_phase	string	Preview phase for feature preview settings. This field is not set for non-preview settings. (BETA, GA, GA_SOON, PRIVATE_PREVIEW, PUBLIC_PREVIEW)
type	string	Sample message depicting the type of the setting. To set this setting, the value sent must match this type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_account_user_preferences_metadata	select	account_id, user_id	page_size, page_token	List valid user preferences and their metadata for a specific user. User preferences are personal

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
account_id	string
user_id	string	User ID of the user whose settings metadata is being retrieved.
page_size	integer	The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 200 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string	A page token, received from a previous ListAccountUserPreferencesMetadataRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountUserPreferencesMetadataRequest must match the call that provided the page token.

SELECT examples

list_account_user_preferences_metadata

List valid user preferences and their metadata for a specific user. User preferences are personal

SELECT
name,
display_name,
description,
docs_link,
preview_phase,
type
FROM databricks_account.settingsv2.account_user_preferences_metadata
WHERE account_id = '{{ account_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;