service-principals-v2 command group
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The service-principals-v2 command group within the Databricks CLI allows you to manage service principal identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms. Databricks recommends creating service principals to run production jobs or modify production data.
databricks service-principals-v2 create
Create a new service principal in the Databricks workspace.
databricks service-principals-v2 create [flags]
Arguments
None
Options
--active
If this service principal is active.
--application-id string
UUID relating to the service principal.
--display-name string
String that represents a concatenation of given and family names.
--external-id string
External ID for the service principal.
--id string
Databricks service principal ID.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Examples
The following example creates a new service principal:
databricks service-principals-v2 create --display-name "my-service-principal"
databricks service-principals-v2 delete
Delete a single service principal from the Databricks workspace.
databricks service-principals-v2 delete ID [flags]
Arguments
ID
Unique ID for a service principal in the Databricks workspace.
Options
Examples
The following example deletes a service principal:
databricks service-principals-v2 delete 12345678
databricks service-principals-v2 get
Get the details for a single service principal defined in the Databricks workspace.
databricks service-principals-v2 get ID [flags]
Arguments
ID
Unique ID for a service principal in the Databricks workspace.
Options
Examples
The following example gets service principal details:
databricks service-principals-v2 get 12345678
databricks service-principals-v2 list
Get the set of service principals associated with a Databricks workspace.
databricks service-principals-v2 list [flags]
Arguments
None
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 service principals:
databricks service-principals-v2 list
databricks service-principals-v2 patch
Partially update the details of a single service principal in the Databricks workspace.
databricks service-principals-v2 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 service principal using a JSON file:
databricks service-principals-v2 patch 12345678 --json @patch.json
databricks service-principals-v2 update
Update the details of a single service principal. This action replaces the existing service principal with the same name.
databricks service-principals-v2 update ID [flags]
Arguments
ID
Databricks service principal ID.
Options
--active
If this service principal is active.
--application-id string
UUID relating to the service principal.
--display-name string
String that represents a concatenation of given and family names.
--external-id string
External ID for the service principal.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Examples
The following example updates a service principal's display name:
databricks service-principals-v2 update 12345678 --display-name "updated-service-principal"
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