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
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The clean-room-auto-approval-rules command group within the Databricks CLI contains commands to manage auto-approval rules for clean rooms. Clean room auto-approval rules automatically create an approval on your behalf when an asset (for example, a notebook) meeting specific criteria is shared in a clean room. See Auto-approval rules.
databricks clean-room-auto-approval-rules create
Create an auto-approval rule for a clean room.
databricks clean-room-auto-approval-rules create CLEAN_ROOM_NAME [flags]
Arguments
CLEAN_ROOM_NAME
The name of the clean room this auto-approval rule belongs to.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example creates an auto-approval rule using JSON:
databricks clean-room-auto-approval-rules create my-clean-room --json '{"author_scope": "ANY_AUTHOR", "runner_collaborator_alias": "collaborator1"}'
The following example creates an auto-approval rule using a JSON file:
databricks clean-room-auto-approval-rules create my-clean-room --json @auto-approval-rule.json
databricks clean-room-auto-approval-rules delete
Delete an auto-approval rule by rule ID.
databricks clean-room-auto-approval-rules delete CLEAN_ROOM_NAME RULE_ID [flags]
Arguments
CLEAN_ROOM_NAME
The name of the clean room this auto-approval rule belongs to.
RULE_ID
A generated UUID identifying the rule.
Options
Examples
The following example deletes an auto-approval rule:
databricks clean-room-auto-approval-rules delete my-clean-room a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
databricks clean-room-auto-approval-rules get
Get an auto-approval rule by rule ID.
databricks clean-room-auto-approval-rules get CLEAN_ROOM_NAME RULE_ID [flags]
Arguments
CLEAN_ROOM_NAME
The name of the clean room this auto-approval rule belongs to.
RULE_ID
A generated UUID identifying the rule.
Options
Examples
The following example gets an auto-approval rule:
databricks clean-room-auto-approval-rules get my-clean-room a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
databricks clean-room-auto-approval-rules list
List all auto-approval rules for the caller in a clean room.
databricks clean-room-auto-approval-rules list CLEAN_ROOM_NAME [flags]
Arguments
CLEAN_ROOM_NAME
The name of the clean room to list auto-approval rules for.
Options
--page-size int
Maximum number of auto-approval rules to return per page.
--page-token string
Token to retrieve the next page of results.
Examples
The following example lists all auto-approval rules:
databricks clean-room-auto-approval-rules list my-clean-room
The following example lists auto-approval rules with pagination:
databricks clean-room-auto-approval-rules list my-clean-room --page-size 10
databricks clean-room-auto-approval-rules update
Update an auto-approval rule by rule ID.
databricks clean-room-auto-approval-rules update CLEAN_ROOM_NAME RULE_ID [flags]
Arguments
CLEAN_ROOM_NAME
The name of the clean room this auto-approval rule belongs to.
RULE_ID
A generated UUID identifying the rule.
Options
--author-collaborator-alias string
Collaborator alias of the author covered by the rule.
--author-scope CleanRoomAutoApprovalRuleAuthorScope
Scope of authors covered by the rule. Supported values: ANY_AUTHOR.
--clean-room-name string
The name of the clean room this auto-approval rule belongs to.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--runner-collaborator-alias string
Collaborator alias of the runner covered by the rule.
Examples
The following example updates an auto-approval rule:
databricks clean-room-auto-approval-rules update my-clean-room a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --author-scope ANY_AUTHOR --runner-collaborator-alias collaborator2
The following example updates an auto-approval rule using JSON:
databricks clean-room-auto-approval-rules update my-clean-room a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{"author_scope": "ANY_AUTHOR", "runner_collaborator_alias": "collaborator3"}'
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