credentials 命令组

The credentials command group within the Databricks CLI allows you to manage credentials for accessing services on your cloud tenant. 每个凭据都受 Unity 目录访问控制策略的约束，这些策略控制哪些用户和组可以访问凭据。

凭据表示用于访问云租户上的服务的身份验证和授权机制。 若要创建凭据，必须是 Databricks 帐户管理员或拥有 CREATE SERVICE CREDENTIAL 该权限。 创建凭据的用户可以将所有权委托给另一个用户或组来管理其权限。

databricks 凭据 create-credential

创建新凭据。 要创建的凭据的类型由 purpose 字段确定，该字段应为或 SERVICESTORAGE。

调用方必须是元存储管理员，或者具有存储凭据或CREATE_SERVICE_CREDENTIAL服务凭据的元存储特权CREATE_STORAGE_CREDENTIAL。

databricks credentials create-credential NAME [flags]

Arguments

NAME

    凭据名称。 该名称在元存储中的存储和服务凭据中必须是唯一的。

选项

--comment string

    与凭据关联的注释

--json JSON

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

--purpose CredentialPurpose

    指示凭据的用途。 支持的值： SERVICE、 STORAGE

--read-only

    凭据是否仅可用于读取作

--skip-validation

    Optional

Global flags

Examples

以下示例创建一个名为 my-service-cred： 的服务凭据：

databricks credentials create-credential my-service-cred --purpose SERVICE

以下示例创建只读存储凭据：

databricks credentials create-credential readonly-storage --purpose STORAGE --read-only

databricks 凭据 delete-credential

从元存储中删除服务或存储凭据。 调用方必须是凭据的所有者。

databricks credentials delete-credential NAME_ARG [flags]

Arguments

NAME_ARG

    凭据的名称

选项

--force

    强制更新，即使存在依赖服务（目的 SERVICE为）或依赖外部位置和外部表（目的为 STORAGE）

Global flags

Examples

以下示例删除名为 ：< a0/> 的 凭据：

databricks credentials delete-credential my-service-cred

以下示例强制删除具有依赖项的凭据：

databricks credentials delete-credential my-storage-cred --force

databricks 凭据 generate-temporary-service-credential

使用指定的服务凭据生成临时服务凭据。 调用方必须是元存储管理员，或者对服务凭据具有元存储权限 ACCESS 。

databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]

Arguments

CREDENTIAL_NAME

    用于生成临时凭据的服务凭据的名称

选项

--json JSON

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

Global flags

Examples

以下示例为服务凭据生成临时凭据：

databricks credentials generate-temporary-service-credential my-service-cred

databricks 凭据 get-credential

从元存储获取服务或存储凭据。 调用方必须是元存储管理员、凭据的所有者，或者对凭据具有任何权限。

databricks credentials get-credential NAME_ARG [flags]

Arguments

NAME_ARG

    凭据的名称

选项

Global flags

Examples

以下示例获取有关名为 的 my-service-cred凭据的信息：

databricks credentials get-credential my-service-cred

databricks 凭据 list-credentials

List credentials. 该列表仅限于调用方有权访问的凭据。 如果调用方是元存储管理员，则不限制检索凭据。 不能保证数组中元素的特定排序。

databricks credentials list-credentials [flags]

选项

--max-results int

    要返回的最大凭据数

--page-token string

    用于检索下一页结果的不透明令牌

--purpose CredentialPurpose

    仅返回指定用途的凭据。 支持的值： SERVICE、 STORAGE

Global flags

Examples

以下示例列出所有凭据：

databricks credentials list-credentials

以下示例仅列出服务凭据：

databricks credentials list-credentials --purpose SERVICE

以下示例列出了最多 10 个结果的凭据：

databricks credentials list-credentials --max-results 10

databricks 凭据 update-credential

更新元存储上的服务或存储凭据。

调用方必须是凭据或元存储管理员的所有者，或者具有 MANAGE 权限。 如果调用方是元存储管理员，则只能 owner 更改字段。

databricks credentials update-credential NAME_ARG [flags]

Arguments

NAME_ARG

    凭据的名称

选项

--comment string

    与凭据关联的注释

--force

    强制更新，即使存在依赖服务（目的 SERVICE为）或依赖外部位置和外部表（目的为 STORAGE）

--isolation-mode IsolationMode

    当前安全对象是否可以从所有工作区或一组特定的工作区访问。 支持的值： ISOLATION_MODE_ISOLATED、 ISOLATION_MODE_OPEN

--json JSON

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

--new-name string

    凭据的新名称

--owner string

    凭据的当前所有者的用户名

--read-only

    凭据是否仅可用于读取作

--skip-validation

    向此参数提供 true 以跳过更新凭据验证

Global flags

Examples

以下示例更新凭据的注释：

databricks credentials update-credential my-service-cred --comment "Updated service credential"

以下示例重命名凭据：

databricks credentials update-credential my-service-cred --new-name my-renamed-cred

以下示例更改凭据的所有者：

databricks credentials update-credential my-service-cred --owner someone@example.com

以下示例将凭据显示为只读：

databricks credentials update-credential my-storage-cred --read-only

databricks 凭据 validate-credential

验证凭据。

对于服务凭据（目的为SERVICEcredential_name），必须提供特定于云的凭据。

对于存储凭据（目的）， STORAGE至少需要提供其中一个 external_location_name 凭据 url 。 如果只提供其中一个，它将用于验证。 如果同时提供这两者， url 将用于验证，并在 external_location_name 检查重叠 URL 时被忽略。 credential_name必须提供特定于云的凭据。

调用方必须是元存储管理员或凭据所有者，或者对元存储和凭据拥有所需的权限（例如， CREATE_EXTERNAL_LOCATION 目的为 STORAGE时）。

databricks credentials validate-credential [flags]

选项

--credential-name string

    Required

--external-location-name string

    要验证的现有外部位置的名称

--json JSON

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

--purpose CredentialPurpose

    凭据的用途。 支持的值： SERVICE、 STORAGE

--read-only

    凭据是否仅可用于读取作

--url string

    要验证的外部位置 URL

Global flags

Examples

以下示例验证服务凭据：

databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE

以下示例验证具有外部位置的存储凭据：

databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location

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 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

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