storage-credentials 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可Databricks 隐私声明,包括任何数据使用规定。

storage-credentials Databricks CLI 中的命令组包含用于管理 Unity 目录中存储凭据的命令。 存储凭据表示用于访问存储在云租户中的数据的身份验证和授权机制。 每个存储凭据都受 Unity 目录访问控制策略的约束,这些策略控制哪些用户和组可以访问凭据。 如果用户无权访问 Unity 目录中的存储凭据,请求将失败,Unity 目录不会代表用户尝试向云租户进行身份验证。 请参阅管理存储凭据

databricks 存储凭证 创建

创建新的存储凭据。

调用方必须是元存储管理员或具有 CREATE_STORAGE_CREDENTIAL 元存储的权限。

databricks storage-credentials create NAME [flags]

Arguments

NAME

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

选项

--comment string

    与凭据关联的注释。

--json JSON

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

--read-only

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

--skip-validation

    提供 true 值给此参数将跳过对已创建凭据的验证。

全局标志

Examples

以下示例创建新的存储凭据:

databricks storage-credentials create my-storage-credential

以下示例使用注释创建存储凭据:

databricks storage-credentials create my-storage-credential --comment "S3 credential for analytics data"

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

databricks storage-credentials create my-storage-credential --read-only

databricks 存储凭证删除

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

databricks storage-credentials delete NAME [flags]

Arguments

NAME

    存储凭据的名称。

选项

--force

    即使目的为STORAGE时存在依赖的外部位置或外部表,或目的为SERVICE时存在依赖服务,也要强制更新。

全局标志

Examples

以下示例删除存储凭据:

databricks storage-credentials delete my-storage-credential

以下示例强制删除存储凭据:

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

databricks 存储凭证获取

从元存储获取存储凭据。 调用方必须是元存储管理员、存储凭据的所有者,或者对存储凭据具有某些权限。

databricks storage-credentials get NAME [flags]

Arguments

NAME

    存储凭据的名称。

选项

全局标志

Examples

以下示例获取有关存储凭据的信息:

databricks storage-credentials get my-storage-credential

databricks storage-credentials 列表

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

databricks storage-credentials list [flags]

选项

--max-results int

    返回的最大存储凭据数量。

--page-token string

    基于先前查询转到下一页的不透明分页令牌。

全局标志

Examples

以下示例列出所有存储凭据:

databricks storage-credentials list

databricks存储凭证更新

更新 metastore 上的存储凭据。

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

databricks storage-credentials update NAME [flags]

Arguments

NAME

    存储凭据的名称。

选项

--comment string

    与凭据关联的注释。

--force

    即使存在依赖的外部位置或外部表,也强制更新。

--isolation-mode IsolationMode

    当前安全对象是可从所有工作区访问还是从特定工作区集访问。 支持的值:[ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]

--json JSON

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

--new-name string

    存储凭据的新名称。

--owner string

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

--read-only

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

--skip-validation

    向此参数提供 true 会跳过对更新后凭据的验证。

全局标志

Examples

以下示例更新存储凭据的注释:

databricks storage-credentials update my-storage-credential --comment "Updated S3 credential"

以下示例更改存储凭据的所有者:

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

以下示例重命名存储凭据:

databricks storage-credentials update my-storage-credential --new-name updated-credential

Databricks 存储凭证验证 (storage-credentials validate)

验证存储凭据。 至少需要提供 external_location_nameurl 中的一个。 如果仅提供其中一个,将使用该参数进行验证。 如果同时提供这两者, url 将用于验证,并在 external_location_name 检查重叠 URL 时被忽略。

要么提供storage_credential_name,要么提供云特定的凭据。

调用方必须是元存储管理员或存储凭据所有者,或者具有 CREATE_EXTERNAL_LOCATION 元存储和存储凭据的权限。

databricks storage-credentials validate [flags]

选项

--external-location-name string

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

--json JSON

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

--read-only

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

--storage-credential-name string

    Required.

--url string

    要验证的外部位置 URL。

全局标志

Examples

以下示例针对外部位置验证存储凭据:

databricks storage-credentials validate --storage-credential-name my-storage-credential --external-location-name my-external-location

以下示例根据 URL 验证存储凭据:

databricks storage-credentials validate --storage-credential-name my-storage-credential --url s3://my-bucket/path

全局标志

--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 字符串

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