注释
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
Important
此功能目前以公共预览版提供。
secrets-uc
Databricks CLI 中的命令组管理 Unity 目录的秘密。 秘密是Unity目录中可保护的对象,用于在三级命名空间(catalog_name.schema_name.secret_name)内存储敏感的凭证数据(如密码、令牌和密钥)。 秘密可以通过标准的 Unity 目录权限管理,并且范围限定在目录中的模式。
Databricks Secrets-UC create-secret
在 Unity 目录中创建一个新的秘密。 你必须是父模式的所有者,或者拥有父模式和USE CATALOG父目录的 CREATE_SECRET 和USE SCHEMA权限。 秘密存储在指定的目录和模式中, 值 字段包含需要安全存储的敏感数据。
databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
NAME
秘密名称相对于其父模式。
CATALOG_NAME
目录名称,即模式和秘密所在的目录。
SCHEMA_NAME
秘密所在的模式名称。
VALUE
隐藏的数值。 该字段仅输入,不会在响应中返回——使用effective_value字段(通过GetSecret,include_value设为true)读取秘密值。 最大容量为60 KiB(加密前)。 接受的内容包括密码、令牌、密钥及其他敏感凭证数据。
选项
--comment string
用户提供的自由文本描述。
--expire-time string
用户提供密钥的有效期。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--owner string
秘密的主人。
Databricks Secrets-uc Delete-Secret
删除秘密的三级(完全限定)名称。 你必须是秘密的拥有者或元商店管理员。
databricks secrets-uc delete-secret FULL_NAME [flags]
Arguments
FULL_NAME
秘密的三级(完全限定)名称(例如, catalog_name.schema_name.secret_name)。
选项
Databricks Secrets-uc get-secret
它的三级(完全合格)名称是一个秘密。 你必须是元存储管理员、秘密的所有者,或者拥有该秘密的 管理 权限。 秘密值默认不会返回。 要检索该信息,你还必须拥有 READ_SECRET 权限,并在请求中将 include_value 设置为true。
databricks secrets-uc get-secret FULL_NAME [flags]
Arguments
FULL_NAME
秘密的三级(完全限定)名称(例如, catalog_name.schema_name.secret_name)。
选项
Databricks Secrets-UC List-Secrets
在 Unity 目录中列出秘密。 你必须是元存储管理员、秘密的所有者,或者拥有该秘密的 管理 权限。 必须同时指定 catalog_name 和 schema_name 以过滤特定模式中的秘密。 结果会被分页;使用响应中的 page_token 字段检索后续页面。
databricks secrets-uc list-secrets [flags]
选项
--catalog-name string
用来列出秘密的目录名称。
--limit int
要返回的最大结果数。
--page-size int
最大可归还的秘密数量。
--schema-name string
用来列出秘密的模式名称。
Databricks Secrets-UC Update-Secret
更新 Unity 目录中的一个现有秘密。 你必须是秘密的拥有者或元商店管理员。如果你是元商店管理员,只有 所有者 字段可以更改。 使用 update_mask 字段指定需要更新的字段。 支持的可更新字段包括 值值、 评论、 所有者和 expire_time。
databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
FULL_NAME
秘密的三级(完全限定)名称(例如, catalog_name.schema_name.secret_name)。
UPDATE_MASK
字段掩码指定需要更新秘密的哪些字段。 如果 update_mask 为 “*”,则所有在 秘密 中指定的字段都会被更新。 如果 update_mask 指定了一个或多个字段,只有这些字段会被更新。 每个指定字段必须秘密设置。 支持字段: 价值、 评论、 所有者、 expire_time。 要更改秘密名称,请删除并重新创建该秘密。
NAME
秘密名称相对于其父模式。
CATALOG_NAME
目录名称,即模式和秘密所在的目录。
SCHEMA_NAME
秘密所在的模式名称。
VALUE
隐藏的数值。 该字段仅输入,不会在响应中返回——使用effective_value字段(通过GetSecret,include_value设为true)读取秘密值。 最大容量为60 KiB(加密前)。 接受的内容包括密码、令牌、密钥及其他敏感凭证数据。
选项
--comment string
用户提供的自由文本描述。
--expire-time string
用户提供密钥的有效期。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--owner string
秘密的主人。
全局标志
--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 字符串
如果适用,要使用的捆绑包目标