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 providers command group within the Databricks CLI contains commands to manage Delta sharing providers. A data provider represents the organization in the real world who shares the data. See What is Delta Sharing?.
databricks providers create
Create a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore.
databricks providers create NAME AUTHENTICATION_TYPE [flags]
Arguments
NAME
The name of the Provider.
AUTHENTICATION_TYPE
The delta sharing authentication type. Supported values: DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN
Options
--comment string
Description about the provider.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--recipient-profile-str string
This field is required when the authentication_type is TOKEN, OAUTH_CLIENT_CREDENTIALS or not provided.
Examples
The following example creates a provider with TOKEN authentication:
databricks providers create my_provider TOKEN --comment "My data provider" --recipient-profile-str "my_profile"
The following example creates a provider with DATABRICKS authentication:
databricks providers create my_provider DATABRICKS --comment "Internal provider"
databricks providers delete
Delete an authentication provider, if the caller is a metastore admin or is the owner of the provider.
databricks providers delete NAME [flags]
Arguments
NAME
Name of the provider.
Options
Examples
The following example deletes a provider:
databricks providers delete my_provider
databricks providers get
Get a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.
databricks providers get NAME [flags]
Arguments
NAME
Name of the provider.
Options
Examples
The following example gets details of a provider:
databricks providers get my_provider
databricks providers list
List available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific ordering of the elements in the array.
databricks providers list [flags]
Options
--data-provider-global-metastore-id string
If not provided, all providers will be returned.
--max-results int
Maximum number of providers to return.
--page-token string
Opaque pagination token to go to next page based on previous query.
Examples
The following example lists all providers:
databricks providers list
The following example lists providers with pagination:
databricks providers list --max-results 10
The following example lists providers for a specific metastore:
databricks providers list --data-provider-global-metastore-id "my-metastore-id"
databricks providers list-provider-share-assets
List assets associated with a specified provider's share. The caller is the recipient of the share.
databricks providers list-provider-share-assets PROVIDER_NAME SHARE_NAME [flags]
Arguments
PROVIDER_NAME
The name of the provider who owns the share.
SHARE_NAME
The name of the share.
Options
--function-max-results int
Maximum number of functions to return.
--notebook-max-results int
Maximum number of notebooks to return.
--table-max-results int
Maximum number of tables to return.
--volume-max-results int
Maximum number of volumes to return.
Examples
The following example lists all assets in a provider's share:
databricks providers list-provider-share-assets my_provider my_share
The following example lists assets with limits on each type:
databricks providers list-provider-share-assets my_provider my_share --table-max-results 5 --function-max-results 3
databricks providers list-shares
List specified provider's shares within the metastore where:
- the caller is a metastore admin,
- or the caller is the owner.
databricks providers list-shares NAME [flags]
Arguments
NAME
Name of the provider in which to list shares.
Options
--max-results int
Maximum number of shares to return.
--page-token string
Opaque pagination token to go to next page based on previous query.
Examples
The following example lists all shares for a provider:
databricks providers list-shares my_provider
The following example lists shares with pagination:
databricks providers list-shares my_provider --max-results 10
databricks providers update
Update the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.
databricks providers update NAME [flags]
Arguments
NAME
Name of the provider.
Options
--comment string
Description about the provider.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--new-name string
New name for the provider.
--owner string
Username of Provider owner.
--recipient-profile-str string
This field is required when the authentication_type is TOKEN, OAUTH_CLIENT_CREDENTIALS or not provided.
Examples
The following example updates a provider's comment:
databricks providers update my_provider --comment "Updated provider description"
The following example updates a provider's name and owner:
databricks providers update my_provider --new-name "my_new_provider" --owner "new_owner@example.com"
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