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 consumer-installations command group within the Databricks CLI contains commands to manage installations for consumers. Installations are entities that allow consumers to interact with Databricks Marketplace listings. SeeManage shared Databricks Marketplace data products.
databricks consumer-installations create
Install a payload associated with a Databricks Marketplace listing.
databricks consumer-installations create LISTING_ID [flags]
Arguments
LISTING_ID
The listing ID to install from
Options
--catalog-name string
The name of the catalog
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--recipient-type DeltaSharingRecipientType
Delta Sharing recipient type. Supported values: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN
--share-name string
The name of the share
Examples
databricks consumer-installations create <listing-id>
databricks consumer-installations delete
Uninstall an installation associated with a Databricks Marketplace listing.
databricks consumer-installations delete LISTING_ID INSTALLATION_ID [flags]
Arguments
LISTING_ID
The listing ID to uninstall from
INSTALLATION_ID
The installation ID to delete
Options
Examples
databricks consumer-installations delete 12345 67890
databricks consumer-installations list
List all installations across all listings.
databricks consumer-installations list [flags]
Arguments
None
Options
--page-size int
Number of items to return per page
--page-token string
Token for pagination
Examples
databricks consumer-installations list
databricks consumer-installations list-listing-installations
List all installations for a particular listing.
databricks consumer-installations list-listing-installations LISTING_ID [flags]
Arguments
LISTING_ID
The listing ID to list installations for
Options
--page-size int
Number of items to return per page
--page-token string
Token for pagination
Examples
databricks consumer-installations list-listing-installations 12345
databricks consumer-installations update
Update an installation. This updates the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table. The token will be rotated if the rotateToken flag is true. The token will be forcibly rotated if the rotateToken flag is true and the tokenInfo field is empty.
databricks consumer-installations update LISTING_ID INSTALLATION_ID [flags]
Arguments
LISTING_ID
The listing ID
INSTALLATION_ID
The installation ID to update
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--rotate-token
Rotate the token
Examples
databricks consumer-installations update 12345 67890
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