Note
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 字串或 @path 整合至包含要求內容的 JSON 檔案。
--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 指定一個或多個欄位,則只有這些欄位會被更新。 每個指定的欄位必須秘密設定。 支援欄位: value、 comment、 owner、 expire_time。 要更改秘密名稱,請刪除並重新建立秘密。
NAME
秘密的名稱,相對於其父結構。
CATALOG_NAME
目錄名稱,裡面有結構和秘密。
SCHEMA_NAME
秘密所在的架構名稱。
VALUE
要儲存的秘密價值。 此欄位僅為輸入,且不會在回應中回傳——使用 effective_value 欄位(透過 GetSecret,include_value 設為 true)讀取秘密值。 最大容量為 60 KiB(加密前)。 被接受的內容包括密碼、令牌、金鑰及其他敏感的憑證資料。
選項
--comment string
使用者提供的自由形式祕密文字說明。
--expire-time string
使用者提供秘密的有效期限。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--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、、appendinplace、 或json
-t, --target 字串
如果適用,要使用的套件組合目標