policy_families

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

Overview

Name	policy_families
Type	Resource
Id	databricks_workspace.compute.policy_families

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Name of the policy family.
policy_family_id	string	Unique identifier for the policy family.
definition	string
description	string	Human-readable description of the purpose of the policy family.

list

Name	Datatype	Description
name	string	Name of the policy family.
policy_family_id	string	Unique identifier for the policy family.
definition	string
description	string	Human-readable description of the purpose of the policy family.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	policy_family_id, deployment_name, workspace_domain	version	Retrieve the information for an policy family based on its identifier and version
list	select	deployment_name, workspace_domain	max_results, page_token	Returns the list of policy definition types available to use at their latest version. This API is

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)
policy_family_id	string	The family ID about which to retrieve information.
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"}})
max_results	integer	Maximum number of policy families to return.
page_token	string	A token that can be used to get the next page of results.
version	integer	The version number for the family to fetch. Defaults to the latest version.

SELECT examples

get

Retrieve the information for an policy family based on its identifier and version

SELECT
name,
policy_family_id,
definition,
description
FROM databricks_workspace.compute.policy_families
WHERE policy_family_id = '{{ policy_family_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND version = '{{ version }}'
;

list

Returns the list of policy definition types available to use at their latest version. This API is

SELECT
name,
policy_family_id,
definition,
description
FROM databricks_workspace.compute.policy_families
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;