users コマンド グループ

注記

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

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

Databricks CLI 内の users コマンド グループを使用すると、Databricks ワークスペースでユーザー ID を管理できます。Databricksによって認識されるユーザーIDは、Eメールアドレスで表されます。「 ユーザーの管理」を参照してください。

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

databricks users create

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ユーザーの電子メールアドレス。

グローバルフラグ

例

次の例では、表示名と Eメール を持つユーザーを作成します。

Bash

databricks users create --display-name "John Doe" --user-name "someone@example.com"

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

Bash

databricks users create --json '{"display_name": "John Doe", "user_name": "someone@example.com", "active": true}'

databricks users delete

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

databricks users delete ID [flags]

引数

ID

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

オプション

グローバルフラグ

例

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

Bash

databricks users delete 12345

databricks users get

Databricks ワークスペースで特定のユーザーの情報を取得します。

databricks users get ID [flags]

引数

ID

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

オプション

--attributes string

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

--count int

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

--excluded-attributes string

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

--filter string

結果をフィルタリングする必要があるクエリ。

--sort-by string

結果を並べ替える属性。

--sort-order GetSortOrder

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

--start-index int

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

グローバルフラグ

例

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

Bash

databricks users get 12345

次の例では、ユーザーの詳細を JSON 形式で取得します。

Bash

databricks users get 12345 --output json

databricks users list

Databricks ワークスペースに関連付けられているすべてのユーザーの詳細を一覧表示します。

databricks users list [flags]

オプション

--attributes string

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

--count int

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

--excluded-attributes string

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

--filter string

結果をフィルタリングする必要があるクエリ。

--sort-by string

結果を並べ替える属性。

--sort-order ListSortOrder

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

--start-index int

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

グローバルフラグ

例

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

Bash

databricks users list

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

Bash

databricks users list --filter "userName eq 'someone@example.com'"

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

Bash

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

databricks users patch

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

databricks users patch ID [flags]

引数

ID

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

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例

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

Bash

databricks users patch 12345 --json '{"display_name": "Jane Doe"}'

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

Bash

databricks users patch 12345 --json @update.json

databricks users update

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

databricks users update ID [flags]

引数

ID

Databricks ユーザー ID。

オプション

--active

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

--display-name string

名前と姓の連結を表す文字列。

--external-id string

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

--id string

Databricks ユーザー ID。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--user-name string

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

グローバルフラグ

例

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

Bash

databricks users update 12345 --display-name "Jane Doe" --user-name "new-someone@example.com" --active

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

Bash

databricks users update 12345 --json '{"display_name": "Jane Doe", "user_name": "new-someone@example.com", "active": true}'

databricks users get-permission-levels

ユーザーがオブジェクトに対して持つことができる権限レベルを取得します。

databricks users get-permission-levels [flags]

オプション

グローバルフラグ

例

次の例では、ユーザーのアクセス許可レベルを取得します。

Bash

databricks users get-permission-levels

次の例では、アクセス許可レベルを JSON 形式で取得します。

Bash

databricks users get-permission-levels --output json

databricks users get-permissions

すべてのパスワードの権限を取得します。パスワードは、ルートオブジェクトから権限を継承できます。

databricks users get-permissions [flags]

オプション

グローバルフラグ

例

次の例では、ユーザーのアクセス許可を取得します。

Bash

databricks users get-permissions

次の例では、JSON 形式でアクセス許可を取得します。

Bash

databricks users get-permissions --output json

databricks users set-permissions

パスワードの権限を設定します。

オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。

databricks users set-permissions [flags]

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例

次の例では、JSON を使用してアクセス許可を設定します。

Bash

databricks users set-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

次の例では、JSON ファイルを使用してアクセス許可を設定します。

Bash

databricks users set-permissions --json @permissions.json

databricks users update-permissions

すべてのパスワードの権限を更新します。パスワードは、ルートオブジェクトから権限を継承できます。

databricks users update-permissions [flags]

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例

次の例では、JSON を使用してアクセス許可を更新します。

Bash

databricks users update-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

次の例では、JSON ファイルを使用してアクセス許可を更新します。

Bash

databricks users update-permissions --json @permissions.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

進行状況ログを表示する形式: default、 append、 inplace、 json

-t, --target string

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