providers 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 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. 数据提供程序表示共享数据的实际组织中的组织。 请参阅什么是 Delta Sharing?

databricks 提供程序创建

根据名称和身份验证类型创建一个新的身份验证提供程序。 调用方必须是元存储上的管理员。

databricks providers create NAME AUTHENTICATION_TYPE [flags]

Arguments

NAME

    提供程序的名称。

AUTHENTICATION_TYPE

    增量共享身份验证类型。 支持的值: DATABRICKSOAUTH_CLIENT_CREDENTIALS、、 OIDC_FEDERATIONTOKEN

选项

--comment string

    有关提供程序的说明。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--recipient-profile-str string

    此字段在提供TOKENOAUTH_CLIENT_CREDENTIALS或未提供时authentication_type是必需的。

Global flags

Examples

以下示例使用 TOKEN 身份验证创建提供程序:

databricks providers create my_provider TOKEN --comment "My data provider" --recipient-profile-str "my_profile"

以下示例使用 DATABRICKS 身份验证创建提供程序:

databricks providers create my_provider DATABRICKS --comment "Internal provider"

databricks 提供程序删除

如果调用方是元存储管理员或提供程序的所有者,请删除身份验证提供程序。

databricks providers delete NAME [flags]

Arguments

NAME

    提供程序的名称。

选项

Global flags

Examples

以下示例删除提供程序:

databricks providers delete my_provider

databricks 提供程序获取

获取特定的身份验证提供程序。 调用方必须提供提供程序的名称,并且必须是元存储管理员或提供程序的所有者。

databricks providers get NAME [flags]

Arguments

NAME

    提供程序的名称。

选项

Global flags

Examples

以下示例获取提供程序的详细信息:

databricks providers get my_provider

databricks 提供程序列表

列出可用的身份验证提供程序。 调用方必须是元存储管理员或提供程序的所有者。 调用方不拥有的提供程序不包括在响应中。 不能保证数组中元素的特定排序。

databricks providers list [flags]

选项

--data-provider-global-metastore-id string

    如果未提供,将返回所有提供程序。

--max-results int

    要返回的最大提供程序数。

--page-token string

    不透明分页令牌根据上一个查询转到下一页。

Global flags

Examples

以下示例列出所有提供程序:

databricks providers list

以下示例列出具有分页的提供程序:

databricks providers list --max-results 10

以下示例列出了特定元存储的提供程序:

databricks providers list --data-provider-global-metastore-id "my-metastore-id"

databricks 提供程序 list-provider-share-assets

列出与指定提供程序共享关联的资产。 调用方是共享的接收方。

databricks providers list-provider-share-assets PROVIDER_NAME SHARE_NAME [flags]

Arguments

PROVIDER_NAME

    拥有共享的提供程序的名称。

SHARE_NAME

    共享的名称。

选项

--function-max-results int

    要返回的最大函数数。

--notebook-max-results int

    要返回的最大笔记本数。

--table-max-results int

    要返回的最大表数。

--volume-max-results int

    要返回的最大卷数。

Global flags

Examples

以下示例列出提供程序共享中的所有资产:

databricks providers list-provider-share-assets my_provider my_share

以下示例列出了对每种类型有限制的资产:

databricks providers list-provider-share-assets my_provider my_share --table-max-results 5 --function-max-results 3

databricks 提供程序 list-shares

列出元存储中的指定提供程序共享,其中:

  • 调用方是元存储管理员,
  • 或调用方是所有者。
databricks providers list-shares NAME [flags]

Arguments

NAME

    要在其中列出共享的提供程序的名称。

选项

--max-results int

    要返回的最大共享数。

--page-token string

    不透明分页令牌根据上一个查询转到下一页。

Global flags

Examples

以下示例列出提供程序的所有共享:

databricks providers list-shares my_provider

以下示例列出具有分页的共享:

databricks providers list-shares my_provider --max-results 10

databricks 提供程序更新

如果调用方是元存储管理员或提供程序的所有者,请更新身份验证提供程序的信息。 如果更新更改了提供程序名称,则调用方必须是元存储管理员和提供程序的所有者。

databricks providers update NAME [flags]

Arguments

NAME

    提供程序的名称。

选项

--comment string

    有关提供程序的说明。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--new-name string

    提供程序的新名称。

--owner string

    提供程序所有者的用户名。

--recipient-profile-str string

    此字段在提供TOKENOAUTH_CLIENT_CREDENTIALS或未提供时authentication_type是必需的。

Global flags

Examples

以下示例更新提供程序的注释:

databricks providers update my_provider --comment "Updated provider description"

以下示例更新提供程序的名称和所有者:

databricks providers update my_provider --new-name "my_new_provider" --owner "new_owner@example.com"

Global flags

--debug

  是否启用调试日志记录。

-h--help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型或 textjson。 默认值是 text

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。

-o, --output 类型

    命令输出类型或 textjson。 默认值是 text

-p, --profile 字符串

    用于运行命令的文件中配置文件 ~/.databrickscfg 的名称。 如果未指定此标志,则如果存在,则使用命名 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

    如果适用,要使用的捆绑包目标