credentials 命令组

Databrickscredentials CLI 中的命令组允许管理用于访问云租户上的服务的凭据。 每个凭据都受 Unity 目录访问控制策略的约束，这些策略控制哪些用户和组可以访问凭据。

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

databricks 凭据 create-credential

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

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

databricks credentials create-credential NAME [flags]

论据

NAME

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

选项

--comment string

    与凭据关联的注释

--json JSON

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

--purpose CredentialPurpose

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

--read-only

    凭据是否仅可用于读取操作

--skip-validation

    可选

全局标志

例子

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

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

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

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

databricks 删除凭据命令

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

databricks credentials delete-credential NAME_ARG [flags]

论据

NAME_ARG

    凭据的名称

选项

--force

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

全局标志

例子

以下示例删除名为my-service-cred的凭据：

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]

论据

CREDENTIAL_NAME

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

选项

--json JSON

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

全局标志

例子

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

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

databricks 凭据 获取凭据

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

databricks credentials get-credential NAME_ARG [flags]

论据

NAME_ARG

    凭据的名称

选项

全局标志

例子

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

databricks credentials get-credential my-service-cred

databricks 凭据 list-credentials

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

databricks credentials list-credentials [flags]

选项

--max-results int

    要返回的最大凭据数

--page-token string

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

--purpose CredentialPurpose

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

全局标志

例子

以下示例列出所有凭据：

databricks credentials list-credentials

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

databricks credentials list-credentials --purpose SERVICE

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

databricks credentials list-credentials --max-results 10

databricks 凭据 更新凭据

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

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

databricks credentials update-credential NAME_ARG [flags]

论据

NAME_ARG

    凭据的名称

选项

--comment string

    与凭据关联的注释

--force

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

--isolation-mode IsolationMode

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

--json JSON

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

--new-name string

    凭据的新名称

--owner string

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

--read-only

    凭据是否仅可用于读取操作

--skip-validation

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

全局标志

例子

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

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

验证凭据。

对于服务凭据（目的为SERVICE），必须提供credential_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

    必选

--external-location-name string

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

--json JSON

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

--purpose CredentialPurpose

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

--read-only

    凭据是否仅可用于读取操作

--url string

    要验证的外部位置 URL

全局标志

例子

以下示例验证服务凭据：

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

全局标志

--debug

  是否启用调试日志记录。

-h 或 --help

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

--log-file 字符串

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

--log-format 格式

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

--log-level 字符串

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

-o, --output 类型

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

-p, --profile 字符串

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

--progress-format 格式

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

-t, --target 字符串

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