注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の users-v2 コマンド グループを使用すると、Databricks ワークスペースでユーザー ID を管理できます。 Databricks では、SCIM プロビジョニングを使用して、ID プロバイダーから Databricks ワークスペースにユーザーとグループを自動的に同期することをお勧めします。
databricks users-v2 create
Databricks ワークスペースに新しいユーザーを作成します。 この新しいユーザーは、Databricks アカウントにも追加されます。
databricks users-v2 create [flags]
論争
なし
オプション
--active
このユーザーがアクティブな場合。
--display-name string
指定された名前とファミリ名の連結を表す文字列。
--external-id string
外部 ID。 現在サポートされていません。
--id string
Databricks ユーザー ID。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--user-name string
Databricks ユーザーのメール アドレス。
例示
次の例では、新しいユーザーを作成します。
databricks users-v2 create --user-name "user@example.com" --display-name "Test User"
databricks users-v2 delete
ユーザーを削除します。 Databricks ワークスペースからユーザーを削除すると、ユーザーに関連付けられているオブジェクトも削除されます。
databricks users-v2 delete ID [flags]
論争
ID
Databricks ワークスペース内のユーザーの一意の ID。
オプション
例示
次の例では、ユーザーを削除します。
databricks users-v2 delete 12345678
databricks users-v2 get
Databricks ワークスペース内の特定のユーザーの情報を取得します。
databricks users-v2 get ID [flags]
論争
ID
Databricks ワークスペース内のユーザーの一意の ID。
オプション
--attributes string
応答で返される属性のコンマ区切りのリスト。
--count int
1 ページあたりの結果の必要な数。
--excluded-attributes string
応答で除外する属性のコンマ区切りのリスト。
--filter string
結果をフィルター処理する必要があるクエリ。
--sort-by string
結果を並べ替える属性。
--sort-order GetSortOrder
結果を並べ替える順序。 サポートされる値: ascending、descending
--start-index int
最初の結果のインデックスを指定します。
例示
次の例では、ユーザーの詳細を取得します。
databricks users-v2 get 12345678
databricks users-v2 list
Databricks ワークスペースに関連付けられているすべてのユーザーの詳細を取得します。
databricks users-v2 list [flags]
論争
なし
オプション
--attributes string
応答で返される属性のコンマ区切りのリスト。
--count int
1 ページあたりの結果の必要な数。
--excluded-attributes string
応答で除外する属性のコンマ区切りのリスト。
--filter string
結果をフィルター処理する必要があるクエリ。
--sort-by string
結果を並べ替える属性。
--sort-order ListSortOrder
結果を並べ替える順序。 サポートされる値: ascending、descending
--start-index int
最初の結果のインデックスを指定します。
例示
次の例では、すべてのユーザーを一覧表示します。
databricks users-v2 list
次の例では、フィルターに一致するユーザーの一覧を示します。
databricks users-v2 list --filter "userName sw \"admin\""
databricks users-v2 パッチ
指定された操作を特定のユーザー属性に適用して、ユーザー リソースを部分的に更新します。
databricks users-v2 patch ID [flags]
論争
ID
Databricks ワークスペースの一意の ID。
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
例示
次の例では、JSON ファイルを使用してユーザーにパッチを適用します。
databricks users-v2 patch 12345678 --json @patch.json
databricks users-v2 の更新
ユーザーの情報を、要求で指定されたデータに置き換えます。
databricks users-v2 update ID [flags]
論争
ID
Databricks ユーザー ID。
オプション
--active
このユーザーがアクティブな場合。
--display-name string
指定された名前とファミリ名の連結を表す文字列。
--external-id string
外部 ID。 現在サポートされていません。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--user-name string
Databricks ユーザーのメール アドレス。
例示
次の例では、ユーザーを更新します。
databricks users-v2 update 12345678 --display-name "Test User"
databricks users-v2 get-permission-levels
ユーザーがオブジェクトに対して持つことができますパスワードのアクセス許可レベルを取得します。
databricks users-v2 get-permission-levels [flags]
論争
なし
オプション
例示
次の例では、パスワードのアクセス許可レベルを取得します。
databricks users-v2 get-permission-levels
databricks users-v2 get-permissions
すべてのパスワードのアクセス許可を取得します。 パスワードは、ルート オブジェクトからアクセス許可を継承できます。
databricks users-v2 get-permissions [flags]
論争
なし
オプション
例示
次の例では、パスワードのアクセス許可を取得します。
databricks users-v2 get-permissions
databricks users-v2 set-permissions
オブジェクトにパスワードのアクセス許可を設定し、既存のアクセス許可が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks users-v2 set-permissions [flags]
論争
なし
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
例示
次の例では、JSON ファイルを使用してパスワードのアクセス許可を設定します。
databricks users-v2 set-permissions --json @permissions.json
databricks users-v2 update-permissions
すべてのパスワードのアクセス許可を更新します。 パスワードは、ルート オブジェクトからアクセス許可を継承できます。
databricks users-v2 update-permissions [flags]
論争
なし
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
例示
次の例では、JSON ファイルを使用してパスワードのアクセス許可を更新します。
databricks users-v2 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、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット