Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
users 内の コマンド グループを使用すると、Databricks ワークスペースでユーザー ID を管理できます。 Databricks によって認識されるユーザー ID は、電子メール アドレスによって表されます。 「ユーザーの管理」を参照してください。
Databricks では、SCIM プロビジョニングを使用して、ID プロバイダーから Databricks ワークスペースにユーザーとグループを自動的に同期することをお勧めします。 SCIM では、ID プロバイダーを使用して Databricks ワークスペースにユーザーとグループを作成し、適切なレベルのアクセス権を付与することで、新しい従業員またはチームのオンボードを効率化します。 ユーザーが組織を離れるか、Databricks ワークスペースにアクセスする必要がなくなった場合、管理者は ID プロバイダーのユーザーを終了でき、そのユーザーのアカウントも Databricks ワークスペースから削除されます。 これにより、一貫したオフボード プロセスが保証され、承認されていないユーザーが機密データにアクセスできなくなります。 SCIM を使用して Microsoft Entra ID からユーザーとグループを同期するを参照してください。
Databricks ユーザーによる作成
Databricks ワークスペースに新しいユーザーを作成します。 この新しいユーザーは、Databricks アカウントにも追加されます。
databricks users create [flags]
オプション
--active
このユーザーがアクティブな場合。
--display-name string
指定された名前とファミリ名の連結を表す文字列。
--external-id string
外部 ID は現在サポートされていません。
--id string
Databricks ユーザー ID。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--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 ワークスペース内のユーザーの一意の ID。
オプション
Examples
次の例では、ID でユーザーを削除します。
databricks users delete 12345
databricks ユーザーが取得する
Databricks ワークスペース内の特定のユーザーの情報を取得します。
databricks users get ID [flags]
Arguments
ID
Databricks ワークスペース内のユーザーの一意の ID。
オプション
--attributes string
応答で返される属性のコンマ区切りのリスト。
--count int
1 ページあたりの結果の必要な数。
--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
1 ページあたりの結果の必要な数。
--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 ファイルに対するインライン JSON 文字列または @path。
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 ユーザー ID。
オプション
--active
このユーザーがアクティブな場合。
--display-name string
指定された名前とファミリ名の連結を表す文字列。
--external-id string
外部 ID は現在サポートされていません。
--id string
Databricks ユーザー ID。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--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 ユーザーの「get-permissions」
すべてのパスワードのアクセス許可を取得します。 パスワードは、ルート オブジェクトからアクセス許可を継承できます。
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 ファイルに対するインライン JSON 文字列または @path。
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 ファイルに対するインライン JSON 文字列または @path。
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、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット