account users コマンド グループ

Databricks CLI 内の account users コマンド グループには、ユーザーに対して作成、取得、一覧表示、更新、および削除操作を実行するコマンドが含まれています。 ユーザー ID は Databricks によって認識され、電子メール アドレスによって表されます。 「ユーザーの管理」を参照してください。

databricks アカウント ユーザーが作成する

Databricks アカウントに新しいユーザーを作成します。

databricks account users create [flags]

オプション

--active

    このユーザーがアクティブな場合。

--display-name string

    指定された名前とファミリ名の連結を表す文字列。

--external-id string

    外部 ID (現在サポートされていません)。

--id string

    Databricks ユーザー ID。

--user-name string

    Databricks ユーザーのメール アドレス。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

例示

次の例では、コマンド ライン フラグを使用してユーザーを作成します。

databricks account users create --user-name "user@example.com" --display-name "Jane Doe"

次の例では、JSON を使用してユーザーを作成します。

databricks account users create --json '{"userName": "user@example.com", "displayName": "Jane Doe", "active": true}'

次の例では、JSON ファイルを使用してユーザーを作成します。

databricks account users create --json @user.json

databricks アカウント ユーザーの削除

Databricks アカウントからユーザーを削除します。 ユーザーを削除すると、ユーザーに関連付けられているオブジェクトも削除されます。

databricks account users delete ID [flags]

論争

ID

    Databricks アカウントのユーザーの一意の ID。

オプション

グローバル フラグ

例示

次の例では、ID でユーザーを削除します。

databricks account users delete 12345

databricks アカウントのユーザーが取得する

Databricks アカウントの特定のユーザーの情報を取得します。

databricks account users 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

    最初の結果のインデックスを指定します。

グローバル フラグ

例示

次の例では、ID でユーザーを取得します。

databricks account users get 12345

次の例では、特定の属性を持つユーザーを取得します。

databricks account users get 12345 --attributes "userName,displayName"

databricks アカウントのユーザー一覧

Databricks アカウントに関連付けられているすべてのユーザーの詳細を取得します。

databricks account users list [flags]

オプション

--attributes string

    応答で返される属性のコンマ区切りのリスト。

--count int

    1 ページあたりの結果の必要な数。

--excluded-attributes string

    応答で除外する属性のコンマ区切りのリスト。

--filter string

    結果をフィルター処理する必要があるクエリ。

--sort-by string

    結果を並べ替える属性。

--sort-order ListSortOrder

    結果を並べ替える順序。 サポートされる値: ascending、descending。

--start-index int

    最初の結果のインデックスを指定します。

グローバル フラグ

例示

次の例では、すべてのユーザーを一覧表示します。

databricks account users list

次の例では、ページネーションを使ってユーザーを列挙します。

databricks account users list --count 10 --start-index 0

次の例では、フィルターを使用するユーザーの一覧を示します。

databricks account users list --filter "userName eq \"user@example.com\""

databricks アカウント ユーザーにパッチを適用する

指定された操作を特定のユーザー属性に適用して、ユーザー リソースを部分的に更新します。

databricks account users patch ID [flags]

論争

ID

    Databricks ワークスペースの一意の ID。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

例示

次の例では、JSON を使用してユーザーにパッチを適用します。

databricks account users patch 12345 --json '{"displayName": "Jane Smith"}'

次の例では、JSON ファイルを使用してユーザーにパッチを適用します。

databricks account users patch 12345 --json @patch-user.json

databricks アカウント ユーザーの更新

ユーザーの情報を、要求で指定されたデータに置き換えます。

databricks account users update ID [flags]

論争

ID

    Databricks ユーザー ID。

オプション

--active

    このユーザーがアクティブな場合。

--display-name string

    指定された名前とファミリ名の連結を表す文字列。

--external-id string

    外部 ID (現在サポートされていません)。

--id string

    Databricks ユーザー ID。

--user-name string

    Databricks ユーザーのメール アドレス。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

例示

次の例では、コマンド ライン フラグを使用してユーザーを更新します。

databricks account users update 12345 --display-name "Jane Smith" --active

次の例では、JSON を使用してユーザーを更新します。

databricks account users update 12345 --json '{"userName": "user@example.com", "displayName": "Jane Smith", "active": true}'

次の例では、JSON ファイルを使用してユーザーを更新します。

databricks account users update 12345 --json @update-user.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 文字列

    該当する場合は、使用するバンドル ターゲット