Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。
credentials
Databricks CLI 中的指令群組允許你管理存取雲端租戶服務的憑證。 每個認證都受限於 Unity 目錄存取原則,可控制哪些使用者和群組可以存取認證。
認證代表存取雲端租用戶上服務的驗證和授權機制。 若要建立認證,您必須是 Databricks 帳戶管理員或具有 CREATE SERVICE CREDENTIAL 許可權。 建立認證的使用者可以將擁有權委派給其他使用者或群組,以管理其許可權。
databricks 認證 建立憑證
建立新的認證。 要建立的認證類型取決於 purpose 欄位,該欄位應為 SERVICE 或 STORAGE。
呼叫者必須是資料庫管理員,或具有儲存憑證的資料庫許可權CREATE_STORAGE_CREDENTIAL或服務憑證的資料庫許可權CREATE_SERVICE_CREDENTIAL。
databricks credentials create-credential NAME [flags]
Arguments
NAME
認證名稱。 名稱在資料存取庫中的存儲和服務憑證之間必須是唯一的。
選項
--comment string
與認證相關聯的批注
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
--purpose CredentialPurpose
指出認證的目的。 支援的值:SERVICE、STORAGE
--read-only
認證是否僅適用於讀取作業
--skip-validation
Optional
Examples
下列範例會建立名為 my-service-cred的服務認證:
databricks credentials create-credential my-service-cred --purpose SERVICE
下列範例會建立唯讀記憶體認證:
databricks credentials create-credential readonly-storage --purpose STORAGE --read-only
databricks 認證 delete-credential
從中繼存放區刪除服務或記憶體認證。 呼叫者必須是憑證的擁有者。
databricks credentials delete-credential NAME_ARG [flags]
Arguments
NAME_ARG
認證的名稱
選項
--force
強制更新,即使有相依的服務(當目的為SERVICE時)或依賴的外部位置與外部資料表(當目的為STORAGE時)。
Examples
下列範例會刪除名為 my-service-cred的認證:
databricks credentials delete-credential my-service-cred
下列範例將強制刪除具有依賴關係的憑證:
databricks credentials delete-credential my-storage-cred --force
databricks 認證 generate-temporary-service-credential
使用指定的服務認證產生暫存服務認證。 呼叫端必須是中繼存放區管理員,或具有服務認證的中繼存放區許可權 ACCESS 。
databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]
Arguments
CREDENTIAL_NAME
用來產生暫存認證的服務認證名稱
選項
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
Examples
下列範例會產生服務認證的暫存認證:
databricks credentials generate-temporary-service-credential my-service-cred
databricks 認證 get-credential
從 Metastore 取得服務或儲存憑證。 呼叫端必須是 Metastore 管理員、憑證擁有者,或擁有憑證的任何權限。
databricks credentials get-credential NAME_ARG [flags]
Arguments
NAME_ARG
認證的名稱
選項
Examples
下列範例會取得名為 my-service-cred 的認證的相關資訊:
databricks credentials get-credential my-service-cred
databricks 憑證 列出憑證
列出資歷。 清單只限於具有存取許可的呼叫者可以使用的認證。 如果呼叫端是中繼存放區管理員,則認證擷取不受限制。 不保證陣列中的元素有特定的順序。
databricks credentials list-credentials [flags]
選項
--max-results int
要傳回的認證數目上限
--page-token string
擷取下一頁結果的不透明令牌
--purpose CredentialPurpose
只傳回指定目的的憑證。 支援的值:SERVICE、STORAGE
Examples
下列範例會列出所有認證:
databricks credentials list-credentials
下列範例只會列出服務認證:
databricks credentials list-credentials --purpose SERVICE
以下範例列出認證資訊,最多顯示 10 筆結果:
databricks credentials list-credentials --max-results 10
databricks 認證 update-credential
更新中繼存放區上的服務或記憶體認證。
呼叫端必須是憑證的擁有者或中繼存放區管理員,或具有 MANAGE 許可權。 如果呼叫端是中繼存放區管理員,則僅能變更owner欄位。
databricks credentials update-credential NAME_ARG [flags]
Arguments
NAME_ARG
認證的名稱
選項
--comment string
與認證相關聯的批注
--force
強制更新,即使有相依的服務(當目的為SERVICE時)或依賴的外部位置與外部資料表(當目的為STORAGE時)。
--isolation-mode IsolationMode
當前的安全實體是否可從所有工作區或特定的一組工作區存取。 支援的值:ISOLATION_MODE_ISOLATED、ISOLATION_MODE_OPEN
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
--new-name string
認證的新名稱
--owner string
目前認證擁有者的用戶名稱
--read-only
認證是否僅適用於讀取作業
--skip-validation
提供 true 給這個自變數,以略過更新認證的驗證
Examples
下列範例會更新憑證的注解:
databricks credentials update-credential my-service-cred --comment "Updated service credential"
下列範例會重新命名認證:
databricks credentials update-credential my-service-cred --new-name my-renamed-cred
下列範例會變更認證的擁有者:
databricks credentials update-credential my-service-cred --owner someone@example.com
以下範例顯示如何將認證設為唯讀:
databricks credentials update-credential my-storage-cred --read-only
databricks 認證 驗證憑證
驗證認證。
針對服務認證(目的為 SERVICE),必須提供 credential_name 或雲端特定的認證。
針對存儲憑證(目的為 STORAGE),至少需要提供 external_location_name 和 url 其中之一。 如果只提供其中一個,則會用於驗證。 如果兩者都提供, url 則會用於驗證,並在 external_location_name 檢查重疊的 URL 時予以忽略。 必須提供credential_name 或雲端特定認證中的任一項。
呼叫者必須是中繼存放區管理員或憑證擁有者,或者在中繼存放區和憑證上具有必要的許可權(例如,當目的為CREATE_EXTERNAL_LOCATION時有STORAGE)。
databricks credentials validate-credential [flags]
選項
--credential-name string
Required
--external-location-name string
要驗證的現有外部位置名稱
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
--purpose CredentialPurpose
認證的用途。 支援的值:SERVICE、STORAGE
--read-only
認證是否僅適用於讀取作業
--url string
要驗證的外部位置 URL
Examples
下列範例會驗證服務認證:
databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE
下列範例會驗證具有外部位置的記憶體認證:
databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location
全域旗標
--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 字串
如果適用,要使用的套件組合目標