Share via


policy-families command group

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 policy-families command group within the Databricks CLI allows you to view available policy families. A policy family contains a policy definition providing best practices for configuring clusters for a particular use case.

Databricks manages and provides policy families for several common cluster use cases. You cannot create, edit, or delete policy families.

Policy families cannot be used directly to create clusters. Instead, you create cluster policies using a policy family. Cluster policies created using a policy family inherit the policy family's policy definition.

databricks policy-families get

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

databricks policy-families get POLICY_FAMILY_ID [flags]

Arguments

POLICY_FAMILY_ID

    The family ID about which to retrieve information.

Options

--version int

    The version number for the family to fetch.

Global flags

databricks policy-families list

List policy definition types available to use at their latest version. This API is paginated.

databricks policy-families list [flags]

Arguments

None

Options

--max-results int

    Maximum number of policy families to return.

--page-token string

    A token that can be used to get the next page of results.

Global flags

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