service-principals command group

Note

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The service-principals command group within the Databricks CLI allows you to manage service principals in your Databricks workspace. See Service principals for CI/CD.

databricks service-principals create

Create a new service principal in the Databricks workspace.

databricks service-principals create [flags]

Options

--active

    If this user 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.

Global flags

Examples

The following example creates a service principal with a display name:

databricks service-principals create --display-name "My Service Principal"

The following example creates a service principal using JSON:

databricks service-principals create --json '{"display_name": "My Service Principal", "active": true}'

databricks service-principals delete

Delete a single service principal in the Databricks workspace.

databricks service-principals delete ID [flags]

Arguments

ID

    Unique ID for a service principal in the Databricks workspace.

Options

Global flags

Examples

The following example deletes a service principal by ID:

databricks service-principals delete 12345

databricks service-principals get

Get the details for a single service principal defined in the Databricks workspace.

databricks service-principals get ID [flags]

Arguments

ID

    Unique ID for a service principal in the Databricks workspace.

Options

Global flags

Examples

The following example gets details for a service principal:

databricks service-principals get 12345

databricks service-principals list

List the set of service principals associated with a Databricks workspace.

databricks service-principals 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.

Global flags

Examples

The following example lists all service principals:

databricks service-principals list

The following example lists service principals with filtering:

databricks service-principals list --filter "displayName eq 'My Service Principal'"

databricks service-principals patch

Partially update the details of a single service principal in the Databricks workspace.

databricks service-principals 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.

Global flags

Examples

The following example patches a service principal:

databricks service-principals patch 12345 --json '{"display_name": "Updated Service Principal"}'

databricks service-principals update

Update the details of a single service principal. This action replaces the existing service principal with the same name.

databricks service-principals update ID [flags]

Arguments

ID

    Databricks service principal ID.

Options

--active

    If this user 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.

Global flags

Examples

The following example updates a service principal:

databricks service-principals update 12345 --display-name "Updated Service Principal" --active

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