CLI的秘密

請注意

Secrets CLI需要Databricks CLI 0.7.1及以上版本。

可以通過將Databricks secrets CLI子命令附加到秘密

有關秘密的更多信息,請參見保密管理

數據秘密——幫助
用法:databricks secrets [OPTIONS] COMMAND [ARGS]…與秘密API交互的實用程序。選項:-v,——version [version]——profile TEXT要使用的CLI連接配置文件。默認配置文件為default。-h,——help顯示此消息並退出。命令:create-scope創建秘密作用域。選項:——scope scope秘密作用域的名稱。——initial-manage-principal可以管理創建的secret作用域的初始主體。如果指定了,則將應用到範圍的具有MANAGE權限的初始ACL分配給提供的主體(用戶或組)。唯一受支持的主體是組“users”,它包含工作區中的所有用戶。 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.

創建秘密作用域

要顯示使用文檔,請運行秘密創建範圍——幫助

數據庫機密創建-scope——scope my-scope

如果成功,則無輸出。

刪除秘密

要顯示使用文檔,請運行秘密刪除——幫助

數據庫機密刪除——scope my-scope——key my-key

如果成功,則無輸出。

撤銷主體的ACL

要顯示使用文檔,請運行秘密delete-acl——幫助

刪除-acl——scope my-scope——principal someone@example.com

如果成功,則無輸出。

刪除秘密作用域

要顯示使用文檔,請運行秘密delete-scope——幫助

刪除數據庫機密——scope my-scope

如果成功,則無輸出。

獲取主體的ACL

要顯示使用文檔,請運行秘密get-acl——幫助

databricks secrets get-acl——scope my-scope——principal someone@example.com——輸出JSON
“主要”:“sonmeone@example.com”,“許可”:“管理”

列出存儲在秘密作用域中的秘密密鑰

要顯示使用文檔,請運行秘密列表——幫助

databricks秘密列表——scope my-scope——輸出JSON
“秘密”:(“關鍵”:“我的鑰匙”,“last_updated_timestamp”:1621284092605

請注意

不能通過Databricks命令行訪問機密值。要訪問秘密值,必須使用Databricks實用程序秘密的效用在一個數據庫筆記本裏。

列出一個秘密作用域的acl

要顯示使用文檔,請運行秘密list-acls——幫助

databricks secrets list-acls——scope my-scope——輸出JSON
“物品”:(“主要”:“someone@example.com”,“許可”:“管理”

列出工作區中所有可用的秘密作用域

要顯示使用文檔,請運行秘密list-scopes——幫助

databricks secrets list-scopes—輸出JSON
“範圍”:[“名稱”:“我的領域”,“backend_type”:“磚”

創建或更新秘密

要顯示使用文檔,請運行秘密——幫助秘密——幫助

有三種方法來保存秘密。最簡單的方法是使用——字符串值選擇;該秘密將以UTF-8 (MB4)格式存儲。您應該小心使用這個選項,因為您的秘密可能以純文本的形式存儲在命令行曆史記錄中。

數據庫機密put——scope my-scope——key my-key——string-value my-value

或者:

數據庫秘密寫——範圍my-範圍——鍵my-鍵——字符串值my-值

如果成功,則無輸出。

你也可以使用——二進製文件選項,提供存儲在文件中的秘密。文件內容將按原樣讀取,並以字節的形式存儲。

數據庫機密設置——scope my-scope——key my-key——二進製文件my-secret.txt

或者:

數據庫機密寫入——scope my-scope——key my-key——二進製文件my-secret.txt

如果成功,則無輸出。

如果您沒有指定一個選項,將打開一個編輯器供您輸入您的秘密。按照編輯器中顯示的說明輸入您的秘密。

數據機密放,範圍我的範圍,鑰匙我的鑰匙

或者:

數據庫機密寫——範圍我的範圍——密鑰我的密鑰
----------------------------------------------------------------------不要編輯上麵的行。它下麵的所有內容都將被忽略。請在該行上方輸入您的秘密值。文本將被存儲utf - 8MB4表單和任何尾隨的新行將被剝離。不保存退出將中止寫入秘密。

將ACL授予或更改為主體的秘密範圍

要顯示使用文檔,請運行秘密put-acl——幫助秘密write-acl——幫助

數據庫秘密——放置acl——scope my-scope——principal someone@example.com——權限管理

或者:

databricks secrets write-acl——scope my-scope——principal someone@example.com——permission MANAGE

如果成功,則無輸出。