users-v2コマンドグループ

注記

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

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

Databricks CLI内のusers-v2コマンドグループを使用すると、Databricks ワークスペース内のユーザー ID を管理できます。Databricks 、 SCIMプロビジョニングを使用して、ユーザーとグループを ID プロバイダーからDatabricksワークスペースに自動的に同期することをお勧めします。

databricks users-v2 作成

Databricksワークスペースで新しいユーザーを作成します。 この新しいユーザーはDatabricksアカウントにも追加されます。

databricks users-v2 create [flags]

議論

なし

オプション

--active

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

--display-name string

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

--external-id string

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

--id string

DatabricksユーザーID。

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--user-name string

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

世界の国旗

例

次の例は、新しいユーザーを作成する例です。

Bash

databricks users-v2 create --user-name "user@example.com" --display-name "Test User"

databricks users-v2 削除

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

databricks users-v2 delete ID [flags]

議論

ID

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

オプション

世界の国旗

例

以下の例は、ユーザーを削除する例です。

Bash

databricks users-v2 delete 12345678

databricks users-v2 を取得する

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

databricks 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

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

世界の国旗

例

以下の例は、ユーザーの詳細情報を取得します。

Bash

databricks users-v2 get 12345678

データブリックスユーザーv2リスト

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

databricks users-v2 list [flags]

議論

なし

オプション

--attributes string

レスポンスで返す属性をカンマ区切りで指定します。

--count int

1ページあたりの表示件数。

--excluded-attributes string

レスポンスから除外する属性をカンマ区切りで指定します。

--filter string

結果を絞り込むためのクエリ。

--sort-by string

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

--sort-order ListSortOrder

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

--start-index int

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

世界の国旗

例

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

Bash

databricks users-v2 list

次の例は、フィルターに一致するユーザーを一覧表示したものです。

Bash

databricks users-v2 list --filter "userName sw \"admin\""

databricks users-v2 パッチ

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

databricks users-v2 patch ID [flags]

議論

ID

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

オプション

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

世界の国旗

例

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

Bash

databricks users-v2 patch 12345678 --json @patch.json

データブリックスユーザーv2アップデート

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

databricks users-v2 update ID [flags]

議論

ID

DatabricksユーザーID。

オプション

--active

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

--display-name string

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

--external-id string

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

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

--user-name string

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

世界の国旗

例

次の例は、ユーザー情報を更新するものです。

Bash

databricks users-v2 update 12345678 --display-name "Test User"

databricks users-v2 get-permission-levels

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

databricks users-v2 get-permission-levels [flags]

議論

なし

オプション

世界の国旗

例

次の例は、パスワードの権限レベルを取得するものです。

Bash

databricks users-v2 get-permission-levels

databricks users-v2 get-permissions

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

databricks users-v2 get-permissions [flags]

議論

なし

オプション

世界の国旗

例

以下の例では、パスワード権限を取得します。

Bash

databricks users-v2 get-permissions

databricks users-v2 set-permissions

オブジェクトにパスワード権限を設定し、既存の権限がある場合はそれを上書きします。指定がない場合、すべての直接アクセス権限を削除します。オブジェクトは、ルートオブジェクトから権限を継承できます。

databricks users-v2 set-permissions [flags]

議論

なし

オプション

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

世界の国旗

例

次の例では、JSONファイルを使用してパスワードの権限を設定します。

Bash

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

databricks users-v2 権限更新

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

databricks users-v2 update-permissions [flags]

議論

なし

オプション

--json JSON

インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。

世界の国旗

例

以下の例は、JSONファイルを使用してパスワードの権限を更新する方法を示しています。

Bash

databricks users-v2 update-permissions --json @permissions.json

世界の国旗

--debug

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

-h または --help

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

--log-file string

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

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

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