หมายเหตุ
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลอง ลงชื่อเข้าใช้หรือเปลี่ยนไดเรกทอรีได้
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลองเปลี่ยนไดเรกทอรีได้
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 account groups command group within the Databricks CLI contains commands to perform create, get, list, update, and delete operations on groups. Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects. See Groups.
databricks account groups create
Create a new group in the Databricks account with a unique name.
databricks account groups create [flags]
Options
--display-name string
String that represents a human-readable group name.
--external-id string
External ID for the group.
--id string
Databricks group ID.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example creates a group using command-line flags:
databricks account groups create --display-name "Data Scientists"
The following example creates a group using JSON:
databricks account groups create --json '{"displayName": "Data Scientists", "externalId": "ds-group-001"}'
The following example creates a group using a JSON file:
databricks account groups create --json @group.json
databricks account groups delete
Delete a group from the Databricks account.
databricks account groups delete ID [flags]
Arguments
ID
Unique ID for a group in the Databricks account.
Options
Examples
The following example deletes a group by ID:
databricks account groups delete 12345
databricks account groups get
Get the information for a specific group in the Databricks account.
databricks account groups get ID [flags]
Arguments
ID
Unique ID for a group in the Databricks account.
Options
Examples
The following example gets a group by ID:
databricks account groups get 12345
databricks account groups list
Get all details of the groups associated with the Databricks account.
Important
As of 08/22/2025, this command does not return members. Instead, members should be retrieved by iterating through Get group details.
databricks account groups list [flags]
Options
--attributes string
Comma-separated list of attributes to return in response.
--count int
Desired number of results per page.
--excluded-attributes string
Comma-separated list of attributes to exclude in response.
--filter string
Query by which the results have to be filtered.
--sort-by string
Attribute to sort the results.
--sort-order ListSortOrder
The order to sort the results. Supported values: ascending, descending.
--start-index int
Specifies the index of the first result.
Examples
The following example lists all groups:
databricks account groups list
The following example lists groups with pagination:
databricks account groups list --count 10 --start-index 0
The following example lists groups with a filter:
databricks account groups list --filter "displayName eq \"Data Scientists\""
databricks account groups patch
Partially update the details of a group.
databricks account groups patch ID [flags]
Arguments
ID
Unique ID in the Databricks workspace.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example patches a group using JSON:
databricks account groups patch 12345 --json '{"displayName": "Updated Group Name"}'
The following example patches a group using a JSON file:
databricks account groups patch 12345 --json @patch-group.json
databricks account groups update
Update the details of a group by replacing the entire group entity.
databricks account groups update ID [flags]
Arguments
ID
Databricks group ID.
Options
--display-name string
String that represents a human-readable group name.
--external-id string
External ID for the group.
--id string
Databricks group ID.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example updates a group using command-line flags:
databricks account groups update 12345 --display-name "Updated Data Scientists"
The following example updates a group using JSON:
databricks account groups update 12345 --json '{"displayName": "Updated Data Scientists", "externalId": "ds-group-002"}'
The following example updates a group using a JSON file:
databricks account groups update 12345 --json @update-group.json
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