account users-v2 コマンド グループ

注記

Databricks CLIの使用には、DatabricksライセンスおよびDatabricksプライバシー通知（使用データ条項を含む）が適用されます。

Databricks CLI内のaccount users-v2コマンド グループには、ユーザーに対する作成、取得、一覧表示、更新、削除の操作を実行するためのコマンドが含まれています。ユーザーIDはDatabricksによって認識され、Eメールアドレスによって表されます。

Databricksでは、SCIMプロビジョニングを使用して、ユーザーとグループをIDプロバイダーからDatabricksアカウントに自動的に同期することをお勧めします。SCIMは、IDプロバイダーを使用してDatabricksアカウントでユーザーとグループを作成し、適切なレベルのアクセス権を付与することで、新しい従業員やチームのオンボーディングを効率化します。ユーザーが組織を離れたり、Databricksアカウントへのアクセスが不要になった場合、管理者はIDプロバイダーでユーザーを停止することができ、そのユーザーのアカウントもDatabricksアカウントから削除されます。これにより、一貫したオフボーディングプロセスが保証され、権限のないユーザーによる機密データへのアクセスを防止できます。ユーザーの管理を参照してください。

Databricks アカウントユーザー-v2 の作成

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

databricks account users-v2 create [flags]

オプション

--active

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

--display-name string

名と姓を連結した文字列。

--external-id string

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

--id string

DatabricksユーザーID。

--json JSON

インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。

--user-name string

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

グローバル フラグ

例

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

Bash

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

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

Bash

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

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

Bash

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

databricks アカウント users-v2 delete

Databricksアカウントからユーザーを削除します。

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

databricks account users-v2 delete ID [flags]

引数

ID

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

オプション

グローバル フラグ

例

以下の例：IDによるユーザーの削除：

Bash

databricks account users-v2 delete 12345

databricks アカウント users-v2 get

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

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

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

グローバル フラグ

例

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

Bash

databricks account users-v2 get 12345

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

Bash

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

databricks アカウント users-v2 list

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

databricks account users-v2 list [flags]

オプション

--attributes string

レスポンスで返す属性のカンマ区切りリスト。

--excluded-attributes string

レスポンスから除外する属性のカンマ区切りリスト。

--filter string

結果のフィルタリングに使用するクエリー。

--limit int

返される結果の最大数。

--sort-by string

結果を並べ替えるための属性。

--sort-order ListSortOrder

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

グローバル フラグ

例

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

Bash

databricks account users-v2 list

次の例では、ページネーションを使用してユーザーを一覧表示します。

Bash

databricks account users-v2 list --limit 10

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

Bash

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

databricks アカウント users-v2 patch

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

databricks account users-v2 patch ID [flags]

引数

ID

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

オプション

--json JSON

インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。

グローバル フラグ

例

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

Bash

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

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

Bash

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

databricks アカウント users-v2 update

リクエストで提供されたデータでユーザーの情報を置き換えます。

databricks account users-v2 update ID [flags]

引数

ID

DatabricksユーザーID。

オプション

--active

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

--display-name string

名と姓を連結した文字列。

--external-id string

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

--json JSON

インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。

--user-name string

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

グローバル フラグ

例

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

Bash

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

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

Bash

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

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

Bash

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

グローバル フラグ

--debug

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

-h または --help

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

--log-file string

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

--log-format format

The log format type, text or json。default値は text です。

--log-level string

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

-o, --output タイプ

コマンドの出力タイプ、text または json。default値は text です。

-p, --profile string

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

--progress-format format

進行状況Logsを表示する形式: default、append、inplace、または json

-t, --target string

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