メインコンテンツまでスキップ

account usersコマンドグループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。

Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。

Databricks CLI内のaccount usersコマンド グループには、ユーザーに対して作成、取得、一覧表示、更新、削除の操作を実行するコマンドが含まれています。 ユーザー ID は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

グローバルフラグ

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

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

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

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

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

Bash
databricks account users create --json @user.json

databricks アカウント ユーザーが削除する

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

databricks account users delete ID [flags]

議論

ID

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

オプション

グローバルフラグ

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

Bash
databricks account users delete 12345

データブリックスアカウントのユーザーは

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

databricks account users get ID [flags]

議論

ID

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

オプション

--attributes string

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

--count int

ページあたりの希望結果数。

--excluded-attributes string

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

--filter string

結果をフィルタリングするクエリ。

--sort-by string

結果を並べ替える属性。

--sort-order GetSortOrder

結果を並べ替える順序。サポートされている値: ascendingdescending

--start-index int

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

グローバルフラグ

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

Bash
databricks account users get 12345

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

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

databricks アカウント ユーザー リスト

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

databricks account users list [flags]

オプション

--attributes string

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

--count int

ページあたりの希望結果数。

--excluded-attributes string

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

--filter string

結果をフィルタリングするクエリ。

--sort-by string

結果を並べ替える属性。

--sort-order ListSortOrder

結果を並べ替える順序。サポートされている値: ascendingdescending

--start-index int

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

グローバルフラグ

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

Bash
databricks account users list

次の例では、ページ区切りを使用してユーザーをリストします。

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

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

Bash
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 を使用してユーザーにパッチを適用します。

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

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

Bash
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

グローバルフラグ

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

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

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

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

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

Bash
databricks account users update 12345 --json @update-user.json

グローバルフラグ

--debug

デバッグ ログを有効にするかどうか。

-h または --help

Databricks CLI または関連コマンド グループまたは関連コマンドのヘルプを表示します。

--log-file string

出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは stderr に書き込まれます。

--log-format format

ログ形式のタイプ、 textまたはjson 。デフォルト値はtextです。

--log-level string

ログ形式のレベルを表す文字列。指定しない場合は、ログ形式のレベルは無効になります。

-o, --output タイプ

コマンド出力タイプ、 textまたはjson 。デフォルト値はtextです。

-p, --profile string

コマンドを実行するために使用する~/.databrickscfgファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULTという名前のプロファイルが使用されます。

--progress-format format

進捗ログを表示する形式: defaultappendinplace 、または json

-t, --target string

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