groups コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のコマンド グループgroupsを使用すると、Databricks ワークスペースでグループを管理できます。グループにより ID 管理が簡素化され、Databricks ワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てることができます。「 グループ」を参照してください。
databricks groups create
指定したグループの詳細を使用して、一意の名前で Databricks ワークスペースにグループを作成します。
databricks groups create [flags]
オプション
--display-name string
人間が判読できるグループ名を表す文字列。
--external-id string
グループの外部 ID
--id string
Databricks グループ ID
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、表示名を持つ新しいグループを作成します。
databricks groups create --display-name "Data Scientists"
次の例では、JSON を使用して新しいグループを作成します。
databricks groups create --json '{"displayName": "Data Scientists"}'
databricks groups delete
Databricks ワークスペースからグループを削除します。
databricks groups delete ID [flags]
引数
ID
Databricks ワークスペース内のグループの一意の ID。
オプション
例
次の例では、ID でグループを削除します。
databricks groups delete 12345
databricks groups get
Databricks ワークスペース内の特定のグループの情報を取得します。
databricks groups get ID [flags]
引数
ID
Databricks ワークスペース内のグループの一意の ID。
オプション
例
次の例では、特定のグループの詳細を取得します。
databricks groups get 12345
databricks groups list
Databricks ワークスペースに関連付けられているグループの詳細をすべて一覧表示します。
databricks groups list [flags]
オプション
--attributes string
応答で返される属性のコンマ区切りリスト。
--count int
ページあたりの必要な結果数。
--excluded-attributes string
応答で除外する属性のコンマ区切りリスト。
--filter string
結果をフィルタリングする必要があるクエリ。
--sort-by string
結果を並べ替える属性。
--sort-order ListSortOrder
結果を並べ替える順序。サポートされている値: ascending、 descending
--start-index int
最初の結果のインデックスを指定します。
例
次の例は、すべてのグループを一覧表示します。
databricks groups list
次の例は、フィルタリングを使用するグループをリストします。
databricks groups list --filter "displayName eq 'Data Scientists'"
次の例は、ページネーションを含むグループを一覧表示します。
databricks groups list --count 10 --start-index 0
databricks groups patch
グループの詳細を部分的に更新します。
databricks groups patch ID [flags]
引数
ID
Databricks ワークスペースの一意の ID。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、JSON を使用してグループを部分的に更新します。
databricks groups patch 12345 --json '{"displayName": "Updated Group Name"}'
databricks groups update
グループ エンティティ全体を置き換えて、グループの詳細を更新します。
databricks groups update ID [flags]
引数
ID
Databricks グループ ID
オプション
--display-name string
人間が判読できるグループ名を表す文字列。
--external-id string
グループの外部 ID
--id string
Databricks グループ ID。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、グループを新しい表示名で更新します。
databricks groups update 12345 --display-name "Updated Group Name"
次の例では、JSON を使用してグループを更新します。
databricks groups update 12345 --json '{"displayName": "Updated Group Name", "id": "12345"}'
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット