Skip to main content

rule_sets

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

Overview

Namerule_sets
TypeResource
Iddatabricks_workspace.iam.rule_sets

Fields

The following fields are returned by SELECT queries:

The rule set was returned successfully.

NameDatatypeDescription
namestring
etagstring
grant_rulesarray

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getrulesetselectdeployment_nameGet a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.
updaterulesetupdatedeployment_nameReplace the rules of a rule set. First, use a GET rule set request to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.

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.

NameDatatypeDescription
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported.

SELECT
name,
etag,
grant_rules
FROM databricks_workspace.iam.rule_sets
WHERE deployment_name = '{{ deployment_name }}' -- required;

UPDATE examples

Replace the rules of a rule set. First, use a GET rule set request to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.

UPDATE databricks_workspace.iam.rule_sets
SET
data__name = '{{ name }}',
data__rule_set = '{{ rule_set }}'
WHERE
deployment_name = '{{ deployment_name }}' --required
RETURNING
name,
etag,
grant_rules;