Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The cluster-policies command group within the Databricks CLI allows you to control users' ability to configure clusters based on a set of rules. These rules specify which attributes or attribute values can be used during cluster creation. Cluster policies have ACLs that limit their use to specific users and groups. See Create and manage compute policies.
databricks cluster-policies create
Create a new policy.
databricks cluster-policies create [flags]
Options
--definition string
Policy definitions document expressed in JSON. See Compute policy reference.
--description string
Additional human-readable description of the cluster policy.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--max-clusters-per-user int
Max number of clusters per user that can be active using this policy.
--name string
Cluster policy name requested by the user.
--policy-family-definition-overrides string
Policy definition document expressed in JSON. See Compute policy reference.
--policy-family-id string
ID of the policy family.
databricks cluster-policies delete
Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.
databricks cluster-policies delete POLICY_ID [flags]
Arguments
POLICY_ID
The ID of the policy to delete.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
databricks cluster-policies edit
Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.
databricks cluster-policies edit POLICY_ID [flags]
Arguments
POLICY_ID
The ID of the policy to update.
Options
--definition string
Policy definitions document expressed in JSON. See Compute policy reference.
--description string
Additional human-readable description of the cluster policy.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--max-clusters-per-user int
Max number of clusters per user that can be active using this policy.
--name string
Cluster policy name requested by the user.
--policy-family-definition-overrides string
Policy definitions document expressed in JSON. See Compute policy reference.
--policy-family-id string
ID of the policy family.
databricks cluster-policies get
Get a cluster policy entity. Creation and editing is available to admins only.
databricks cluster-policies get POLICY_ID [flags]
Arguments
POLICY_ID
Canonical unique identifier for the cluster policy.
Options
databricks cluster-policies list
List the policies accessible by the requesting user.
databricks cluster-policies list [flags]
Options
--sort-column ListSortColumn
The cluster policy attribute to sort by. Supported values: POLICY_CREATION_TIME, POLICY_NAME
--sort-order ListSortOrder
The order in which the policies get listed. Supported values: ASC, DESC
databricks cluster-policies get-permission-levels
Get cluster policy permission levels.
databricks cluster-policies get-permission-levels CLUSTER_POLICY_ID [flags]
Arguments
CLUSTER_POLICY_ID
The cluster policy for which to get or manage permissions.
Options
databricks cluster-policies get-permissions
Get the permissions of a cluster policy. Cluster policies can inherit permissions from their root object.
databricks cluster-policies get-permissions CLUSTER_POLICY_ID [flags]
Arguments
CLUSTER_POLICY_ID
The cluster policy for which to get or manage permissions.
Options
databricks cluster-policies set-permissions
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.
databricks cluster-policies set-permissions CLUSTER_POLICY_ID [flags]
Arguments
CLUSTER_POLICY_ID
The cluster policy for which to get or manage permissions.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
databricks cluster-policies update-permissions
Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root object.
databricks cluster-policies update-permissions CLUSTER_POLICY_ID [flags]
Arguments
CLUSTER_POLICY_ID
The cluster policy for which to get or manage permissions.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use