秘密CLI(遗留)
重要的
这个文档已经退休了,可能不会被更新。
这个信息适用于遗留数据砖CLI版本0.17及以下。砖建议你使用新砖CLI的版本0.200或更高版本。看到砖CLI。找到你的版本的砖CLI,运行砖- v。
从砖CLI或低于0.17版本迁移到砖CLI版本0.200或更高版本,看看砖CLI的迁移。
你跑砖CLI子命令,添加他们的秘密砖秘密。这些子命令调用秘密的API。
更多信息的秘密,明白了保密管理。
请注意
秘密CLI需要砖CLI是0.7.1或以上。
砖的秘密——帮助
用法:砖秘密[选项]命令(ARGS)……效用与秘密API进行交互。选项:- v、版本(版本)——概要文本使用CLI连接配置文件。默认的配置文件是“默认”。- h,帮助显示此消息并退出。命令:创建范围创建了一个秘密的范围。选择:——范围的名称秘密范围范围。——initial-manage-principal初始本金可以管理创建的秘密范围。如果指定了,最初的ACL使用管理权限范围适用于分配给提供的主要(用户或组)。唯一的支持主要是“用户”,在工作区中包含所有用户。 If not specified, the initial ACL with MANAGE permission applied to the scope is assigned to request issuer's user identity. delete Deletes a secret. Options: --scope SCOPE The name of the secret scope. --key KEY The name of secret key. delete-acl Deletes an access control rule for a principal. Options: --scope SCOPE The name of the scope. --principal PRINCIPAL The name of the principal. delete-scope Deletes a secret scope. Options: --scope SCOPE The name of the secret scope. get-acl Gets the details for an access control rule. Options: --scope SCOPE The name of the secret scope. --principal PRINCIPAL The name of the principal. --output FORMAT JSON or TABLE. Set to TABLE by default. list Lists all the secrets in a scope. Options: --scope SCOPE The name of the secret scope. --output FORMAT JSON or TABLE. Set to TABLE by default. list-acls Lists all access control rules for a given secret scope. Options: --scope SCOPE The name of the secret scope. --output FORMAT JSON or TABLE. Set to TABLE by default. list-scopes Lists all secret scopes. --output FORMAT JSON or TABLE. Set to TABLE by default. put Puts a secret in a scope. Options: --scope SCOPE The name of the secret scope. --key KEY The name of the secret key. --string-value TEXT Read value from string and stored in UTF-8 (MB4) form --binary-file PATH Read value from binary-file and stored as bytes. put-acl Creates or overwrites an access control rule for a principal applied to a given secret scope. Options: --scope SCOPE The name of the secret scope. --principal PRINCIPAL The name of the principal. --permission [MANAGE|WRITE|READ] The permission to apply. write Puts a secret in a scope. "write" is an alias for "put". Options: --scope SCOPE The name of the secret scope. --key KEY The name of the secret key. --string-value TEXT Read value from string and stored in UTF-8 (MB4) form --binary-file PATH Read value from binary-file and stored as bytes. write-acl Creates or overwrites an access control rule for a principal applied to a given secret scope. "write-acl" is an alias for "put-acl". Options: --scope SCOPE The name of the secret scope. --principal PRINCIPAL The name of the principal. --permission [MANAGE|WRITE|READ] The permission to apply.
获得主要的ACL
显示使用文档,运行砖秘密get-acl——帮助。
砖秘密get-acl——我的领域范围——主体someone@example.com——JSON输出
{“主要”:“sonmeone@example.com”,“许可”:“管理”}
列出密钥存储在一个秘密的范围
显示使用文档,运行砖秘密列表——帮助。
砖的秘密——我的领域范围列表JSON输出
{“秘密”:({“关键”:“我的钥匙”,“last_updated_timestamp”: 1621284092605}]}
请注意
你不能访问秘密值通过使用砖CLI。访问秘密值,您必须使用砖实用工具秘密的效用在砖笔记本。
一个秘密的acl范围列表
显示使用文档,运行砖秘密list-acls——帮助。
砖秘密list-acls——我的领域范围,JSON输出
{“物品”:({“主要”:“someone@example.com”,“许可”:“管理”}]}
在工作区中列出所有可用的秘密范围
显示使用文档,运行砖秘密list-scopes——帮助。
砖秘密list-scopes——JSON输出
{“范围”:[{“名称”:“我的领域”,“backend_type”:“砖”}]}
创建或更新一个秘密
显示使用文档,运行砖秘密把——帮助或砖秘密写——帮助。
有三种方法来存储一个秘密。最简单的方法是使用——字符串值选择;这个秘密将存储在utf - 8 (MB4)形式。你应该小心使用这个选项,因为你的秘密可能存储在你的在纯文本命令行历史。
砖秘密的把我的领域范围,关键我的钥匙——字符串值自己的价值
或者:
砖的秘密写——我的领域范围,关键我的钥匙——字符串值自己的价值
如果成功,没有显示输出。
您还可以使用——二进制文件选项提供一个秘密存储在一个文件中。文件内容将读取和存储为字节。
砖秘密的把我的领域范围,关键我的钥匙——二进制文件my-secret.txt
或者:
砖的秘密写——我的领域范围,关键我的钥匙——二进制文件my-secret.txt
如果成功,没有显示输出。
如果你不指定一个选项,将打开一个编辑器让你输入你的秘密。按照说明显示在编辑器中输入您的秘密。
砖的秘密——我的领域范围,关键我的钥匙
或者:
砖秘密写——我的领域范围,关键我的钥匙
#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -#不编辑上面的线。它下面的一切将被忽略。#请输入你的秘密值高于线。文本将被存储在#utf - 8(MB4)形式和任何落后于新的线将被剥夺。#不保存退出将中止写作的秘密。