Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。
users
Databricks CLI 中的指令群組允許您管理 Databricks 工作空間中的使用者身份。 Databricks 所辨識的使用者身分識別會以電子郵件位址表示。 請參閱 管理使用者。
Databricks 建議使用 SCIM 布建,自動將使用者和群組從識別提供者同步至 Databricks 工作區。 SCIM 可簡化新員工或小組的上線,方法是使用您的身分識別提供者在 Databricks 工作區中建立使用者和群組,併為他們提供適當的存取層級。 當使用者離開組織或不再需要 Databricks 工作區的存取權時,系統管理員可以終止身分識別提供者中的使用者,而且該用戶帳戶也會從 Databricks 工作區中移除。 這可確保一致的下架程式,並防止未經授權的使用者存取敏感資料。 請參閱 使用 SCIM 從 Microsoft Entra ID 同步使用者和群組。
databricks 使用者建立
在 Databricks 工作區中建立新的使用者。 此新使用者也會新增至 Databricks 帳戶。
databricks users create [flags]
選項
--active
如果此使用者處於活躍狀態。
--display-name string
字串,表示指定和系列名稱的串連。
--external-id string
目前不支援外部標識碼。
--id string
Databricks 用戶標識碼。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--user-name string
Databricks 用戶的電子郵件位址。
Examples
下列範例會建立具有顯示名稱和電子郵件的使用者:
databricks users create --display-name "John Doe" --user-name "someone@example.com"
下列範例會使用 JSON 建立使用者:
databricks users create --json '{"display_name": "John Doe", "user_name": "someone@example.com", "active": true}'
databricks 用戶刪除
刪除使用者。 從 Databricks 工作區刪除使用者也會移除與使用者相關聯的物件。
databricks users delete ID [flags]
Arguments
ID
Databricks 工作區中使用者的唯一標識符。
選項
Examples
下列範例會依識別碼刪除使用者:
databricks users delete 12345
databricks 使用者取得
取得 Databricks 工作區中特定用戶的資訊。
databricks users get ID [flags]
Arguments
ID
Databricks 工作區中使用者的唯一標識符。
選項
--attributes string
要以逗號分隔的屬性清單,以回應傳回。
--count int
每個頁面所需的結果數目。
--excluded-attributes string
在回應中排除的屬性清單,以逗號分隔。
--filter string
透過查詢來篩選結果。
--sort-by string
排序結果的屬性。
--sort-order GetSortOrder
排序結果的順序。 支援的值:ascending、descending
--start-index int
指定第一個結果的索引。
Examples
下列範例會取得使用者的詳細資料:
databricks users get 12345
下列範例會以 JSON 格式取得使用者詳細資料:
databricks users get 12345 --output json
databricks 用戶清單
列出與 Databricks 工作區相關聯之所有用戶的詳細數據。
databricks users list [flags]
選項
--attributes string
要以逗號分隔的屬性清單,以回應傳回。
--count int
每個頁面所需的結果數目。
--excluded-attributes string
在回應中排除的屬性清單,以逗號分隔。
--filter string
透過查詢來篩選結果。
--sort-by string
排序結果的屬性。
--sort-order ListSortOrder
排序結果的順序。 支援的值:ascending、descending
--start-index int
指定第一個結果的索引。
Examples
下列範例會列出所有使用者:
databricks users list
下列範例列出篩選的使用者:
databricks users list --filter "userName eq 'someone@example.com'"
下列範例會列出具有分頁的使用者:
databricks users list --count 10 --start-index 0
databricks 用戶修補程式
在特定的使用者屬性上套用提供的作業,以部分更新用戶資源。
databricks users patch ID [flags]
Arguments
ID
Databricks 工作區中的唯一 ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
下列範例會修補使用者:
databricks users patch 12345 --json '{"display_name": "Jane Doe"}'
下列範例會使用 JSON 檔案修補使用者:
databricks users patch 12345 --json @update.json
更新 Databricks 使用者資訊
以要求中提供的數據取代用戶的資訊。
databricks users update ID [flags]
Arguments
ID
Databricks 用戶標識碼。
選項
--active
如果此使用者處於活躍狀態。
--display-name string
字串,表示指定和系列名稱的串連。
--external-id string
目前不支援外部標識碼。
--id string
Databricks 用戶標識碼。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--user-name string
Databricks 用戶的電子郵件位址。
Examples
下列範例會更新使用者:
databricks users update 12345 --display-name "Jane Doe" --user-name "new-someone@example.com" --active
下列範例會使用 JSON 更新使用者:
databricks users update 12345 --json '{"display_name": "Jane Doe", "user_name": "new-someone@example.com", "active": true}'
databricks 使用者獲取許可級別
取得使用者可以在 對象上擁有的許可權等級。
databricks users get-permission-levels [flags]
選項
Examples
下列範例會取得使用者的權限等級:
databricks users get-permission-levels
下列範例會取得 JSON 格式的權限等級:
databricks users get-permission-levels --output json
databricks 用戶獲取權限
取得所有密碼的許可權。 密碼可以從其根對象繼承許可權。
databricks users get-permissions [flags]
選項
Examples
下列範例會取得使用者的許可權:
databricks users get-permissions
下列範例會取得 JSON 格式的權限:
databricks users get-permissions --output json
databricks 使用者 設定權限
設定密碼許可權。
設定物件的許可權,若已有許可權則予以取代。 如果未指定任何許可權,則刪除所有直接許可權。 物件可以從其根對象繼承許可權。
databricks users set-permissions [flags]
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
下列範例會使用 JSON 來設定權限:
databricks users set-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'
下列範例會使用 JSON 檔案來設定權限:
databricks users set-permissions --json @permissions.json
databricks 使用者更新許可權
更新所有密碼的許可權。 密碼可以從其根對象繼承許可權。
databricks users update-permissions [flags]
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
下列範例會使用 JSON 更新權限:
databricks users update-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
下列範例會使用 JSON 檔案更新權限:
databricks users update-permissions --json @permissions.json
全域旗標
--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 字串
如果適用,要使用的套件組合目標