Note
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。
secrets
Databricks CLI 中的指令群組允許你管理秘密、秘密範圍及存取權限。 有時候存取資料需要您透過 JDBC 向外部資料源進行驗證。 請使用 Databricks 機密資料來儲存您的認證，並在筆記本和作業中引用它們，而不是直接輸入認證。 請參閱機密管理。
databricks 機密建立範圍
建立新的秘密範圍。
範圍名稱必須包含英數位元、破折號、底線和句點，不得超過 128 個字元。
databricks secrets create-scope SCOPE [flags]
Arguments
SCOPE
使用者要求的範圍名稱。 範圍名稱是唯一的。
選項
--initial-manage-principal string
最初授與 MANAGE 許可權給已建立範圍的主體。
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
--scope-backend-type ScopeBackendType
將會使用來建立範圍的後端類型。 支援的值：AZURE_KEYVAULT、DATABRICKS
databricks 秘密 delete-acl
刪除指定範圍中的指定 ACL。
用戶必須具有 MANAGE 叫用此命令的許可權。
RESOURCE_DOES_NOT_EXIST如果不存在這類秘密範圍、主體或 ACL，則會擲回 。
PERMISSION_DENIED如果使用者沒有進行此 API 呼叫的權限， 則擲回 。
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
要移除許可權的範圍名稱。
PRINCIPAL
要從現有 ACL 中移除的主體。
選項
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
databricks 憑證 刪除範圍
刪除秘密範圍。
如果範圍不存在，則引發RESOURCE_DOES_NOT_EXIST。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets delete-scope SCOPE [flags]
Arguments
SCOPE
要刪除的範圍名稱。
選項
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
databricks 機密 刪除機密
刪除儲存在此秘密範圍中的秘密。 您必須在秘密範圍中擁有 WRITE 或 MANAGE 許可權。
如果不存在這類秘密範圍或秘密，則擲出RESOURCE_DOES_NOT_EXIST。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets delete-secret SCOPE KEY [flags]
Arguments
SCOPE
包含要刪除之秘密的範圍名稱。
KEY
要刪除的密鑰名稱。
選項
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
databricks 秘密 取得 ACL
取得指定 ACL 的詳細數據，例如群組和許可權。 用戶必須具有 MANAGE 叫用此 API 的許可權。
拋出RESOURCE_DOES_NOT_EXIST如果不存在這類秘密範圍。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
要從中擷取 ACL 資訊的範圍名稱。
PRINCIPAL
要擷取 ACL 資訊的主體。
選項
databricks 秘密 get-secret
取得指定範圍和鍵的秘密值之位元組表示形式。
使用者需要 READ 許可權才能進行此呼叫。
請注意，傳回的秘密值是以位元組為單位。 在 DBUtils 中，位元組的解譯由呼叫端決定，並決定數據解碼為哪種類型。
PERMISSION_DENIED如果使用者沒有進行此 API 呼叫的權限， 則擲回 。 如果不存在這個秘密或秘密範圍，則會擲回RESOURCE_DOES_NOT_EXIST。
databricks secrets get-secret SCOPE KEY [flags]
Arguments
SCOPE
要從中擷取秘密資訊的範圍名稱。
KEY
要擷取秘密的金鑰。
選項
databricks 機密項目 list-acls
列出指定秘密範圍的訪問控制列表（ACL）。 用戶必須具有 MANAGE 叫用此 API 的許可權。
拋出RESOURCE_DOES_NOT_EXIST如果不存在這類秘密範圍。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets list-acls SCOPE [flags]
Arguments
SCOPE
要從中擷取 ACL 資訊的範圍名稱。
選項
databricks 秘密清單範圍
列出工作區中可用的所有秘密範圍。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets list-scopes [flags]
選項
databricks 秘密 list-secrets
列出儲存在此範圍的秘密金鑰。 這是僅限元數據的作業;無法使用此命令擷取秘密數據。 使用者需要 READ 許可權才能進行此呼叫。
傳回的 lastUpdatedTimestamp 是自 Unix 時間戳的毫秒數。 拋出RESOURCE_DOES_NOT_EXIST如果不存在這類秘密範圍。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets list-secrets SCOPE [flags]
Arguments
SCOPE
列出內秘密的範圍名稱。
選項
databricks 秘密 put-acl
在指定的範圍點上建立或覆寫與指定主體 （使用者或群組） 相關聯的訪問控制清單 （ACL）。
一般而言，使用者或群組會使用他們最強大的許可權，且許可權會依下列方式排序：
-
MANAGE允許更改 ACL、讀取和寫入這個秘密儲存區。 -
WRITE允許讀取和寫入此秘密範圍。 -
READ允許讀取此秘密範圍，並列出可用的秘密。
請注意，一般而言，秘密值只能在叢集的命令內讀取（例如，透過筆記本）。 沒有 API 可讀取叢集外部的實際秘密值數據。 不過，用戶的許可權將會根據執行命令的人員來套用，而且他們至少必須具有 READ 許可權。
用戶必須具有 MANAGE 叫用此命令的許可權。
主體是指與現有的 Databricks 使用者或群組對應的名稱，其存取權限可以被授予或撤銷。
拋出RESOURCE_DOES_NOT_EXIST如果不存在這類秘密範圍。 如果主體的權限已經存在，則擲 RESOURCE_ALREADY_EXISTS 回 。 如果權限或主體無效，則擲出INVALID_PARAMETER_VALUE。
PERMISSION_DENIED如果使用者沒有進行此呼叫的許可權，則擲回 。
databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]
Arguments
SCOPE
要套用權限的範圍名稱。
PRINCIPAL
授予許可權的主體。
PERMISSION
套用至主體的許可權等級。 支援的值：MANAGE、READ、WRITE
選項
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
databricks 機密 put-secret
使用指定的名稱，在提供的範圍下插入機密。 如果已經存在具有相同名稱的密鑰，此命令會覆寫現有的密鑰值。 伺服器會在儲存秘密之前，先使用秘密範圍的加密設定來加密秘密。
您必須在秘密範圍中擁有 WRITE 或 MANAGE 許可權。 秘密密鑰必須包含英數位元、破折號、底線和句號，而且不能超過 128 個字元。 允許的秘密值大小上限為 128 KB。 指定範圍中的秘密數目上限為 1000。
自變數 string-value 或 bytes-value 指定秘密的類型，這會決定要求秘密值時所傳回的值。
您可以使用下列三種方式之一來指定秘密值：
- 使用
--string-value旗標將值指定為字串。 - 在互動提示時輸入密碼（單行密碼輸入）。
- 透過標準輸入傳遞秘密（多行秘密）。
databricks secrets put-secret SCOPE KEY [flags]
Arguments
SCOPE
用來儲存秘密的範圍名稱。
KEY
秘密的金鑰名稱。
選項
--bytes-value string
如果指定，值會儲存為位元組。
--json JSON
內嵌 JSON 字串或 @path 具有要求本文的 JSON 檔案。
--string-value string
如果指定，請注意值會以UTF-8 （MB4） 格式儲存。
全域旗標
--debug
是否要啟用偵錯記錄。
-h 或 --help
顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。
--log-file 字串
字串，表示要寫入輸出記錄檔的檔案。 若未指定此旗標，則預設值是將輸出記錄寫入 stderr。
--log-format 格式
記錄格式類型或 textjson。 預設值是 text。
--log-level 字串
表示日誌格式層級的字串。 若未指定，則日誌的格式層級功能將被停用。
-o, --output 類型
指令輸出類型或 textjson。 預設值是 text。
-p, --profile 字串
要用來執行命令之檔案中的 ~/.databrickscfg 配置檔名稱。 如果未指定此旗標，則如果存在，則會使用名為 DEFAULT 的配置檔。
--progress-format 格式
顯示進度記錄的格式：default、、appendinplace、 或json
-t, --target 字串
如果適用，要使用的套件組合目標