account service-principals-v2 コマンド グループ
Databricks CLIの使用には、使用データ条項を含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のaccount service-principals-v2コマンド グループには、Service Principalに対する作成、取得、一覧表示、更新、削除の操作を実行するためのコマンドが含まれています。Service Principalは、ジョブ、自動化ツール、およびスクリプト、アプリ、CI/CD プラットフォームなどのシステムで使用する ID です。Databricksでは、本番運用ジョブのランや本番運用データの変更を行うService Principalの作成を推奨しています。本番運用データに対して動作するすべてのプロセスがService Principalを使用してランされる場合、本番運用において対話型ユーザーに書き込み、削除、または変更の権限は必要ありません。これにより、ユーザーが誤って本番運用データを上書きしてしまうリスクを排除できます。
databricks アカウント Service Principal-v2 create
Databricks アカウントに新しい Service Principal を作成します。
databricks account service-principals-v2 create [flags]
オプション
--active
このユーザーがアクティブな場合。
--application-id string
Service Principalに関連するUUID。
--display-name string
名と姓を連結した文字列。
--external-id string
外部 ID。
--id string
Databricks Service Principal ID。
--json JSON
インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。
例
次の例では、コマンドラインフラグを使用して Service Principal を作成します：
databricks account service-principals-v2 create --display-name "CI/CD Service Principal"
次の例では、JSONを使用してService Principalを作成します。
databricks account service-principals-v2 create --json '{"displayName": "CI/CD Service Principal", "active": true}'
次の例では、JSON ファイルを使用して Service Principal を作成します：
databricks account service-principals-v2 create --json @service-principal.json
databricks アカウント Service Principal-v2 delete
DatabricksアカウントからService Principalを削除します。
databricks account service-principals-v2 delete ID [flags]
引数
ID
Databricksアカウント内のService Principalの一意のID。
オプション
例
次の例では、IDを指定してService Principalを削除します。
databricks account service-principals-v2 delete 12345
databricks アカウント Service Principal-v2 get
Databricks アカウントで定義されている単一の Service Principal の詳細を取得します。
databricks account service-principals-v2 get ID [flags]
引数
ID
Databricksアカウント内のService Principalの一意のID。
オプション
例
次の例では、IDによってService Principalを取得します。
databricks account service-principals-v2 get 12345
databricks アカウント Service Principal-v2 list
Databricksアカウントに関連付けられているService Principalのセットを取得します。
databricks account service-principals-v2 list [flags]
オプション
--attributes string
レスポンスで返す属性のカンマ区切りリスト。
--excluded-attributes string
レスポンスから除外する属性のカンマ区切りリスト。
--filter string
結果のフィルタリングに使用するクエリー。
--limit int
返される結果の最大数。
--sort-by string
結果を並べ替えるための属性。
--sort-order ListSortOrder
結果を並べ替える順序。サポートされている値: ascending、 descending。
例
次の例では、すべてのService Principalを一覧表示します。
databricks account service-principals-v2 list
次の例では、ページネーションを使用してService Principalを一覧表示します。
databricks account service-principals-v2 list --limit 10
次の例では、フィルタを使用して Service Principal を一覧表示します。
databricks account service-principals-v2 list --filter "displayName eq \"CI/CD Service Principal\""
databricks アカウント Service Principal-v2 patch
Databricksアカウント内の単一のService Principalの詳細を部分的に更新します。
databricks account service-principals-v2 patch ID [flags]
引数
ID
Databricks ワークスペース内の固有の ID。
オプション
--json JSON
インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。
例
次の例では、 JSON を使用してService Principalにパッチを適用します。
databricks account service-principals-v2 patch 12345 --json '{"displayName": "Updated CI/CD Service Principal"}'
次の例では、JSONファイルを使用してService Principalにパッチを適用します。
databricks account service-principals-v2 patch 12345 --json @patch-service-principal.json
databricks アカウント Service Principal-v2 update
Databricksアカウント内のService Principalを置き換えます。
databricks account service-principals-v2 update ID [flags]
引数
ID
Databricks Service Principal ID。
オプション
--active
このユーザーがアクティブな場合。
--application-id string
Service Principalに関連するUUID。
--display-name string
名と姓を連結した文字列。
--external-id string
外部 ID。
--json JSON
インラインJSON文字列、またはリクエスト本文を含む @path/to/file.json のいずれか。
例
次の例では、コマンドライン フラグを使用してService Principalを更新します。
databricks account service-principals-v2 update 12345 --display-name "Updated CI/CD Service Principal" --active
以下の例では、JSONを使用してService Principalを更新します。
databricks account service-principals-v2 update 12345 --json '{"displayName": "Updated CI/CD Service Principal", "active": true}'
次の例では、JSONファイルを使用してService Principalを更新します。
databricks account service-principals-v2 update 12345 --json @update-service-principal.json
グローバル フラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、または関連するコマンドグループやコマンドのヘルプを表示します。
--log-file string
出力Logsの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、defaultでは出力Logsが stderr に書き込まれます。
--log-format format
ログ形式タイプ（text または json）。default値は text です。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ形式レベルは無効になります。
-o, --output タイプ
コマンド出力タイプ、text または json。default値は text です。
-p, --profile string
コマンドの実行に使用する~/.databrickscfgファイル内のプロファイル名。このフラグが指定されていない場合、DEFAULTという名前のプロファイルが存在すれば、それが使用されます。
--progress-format format
進行状況Logsを表示する形式：default、append、inplace、または json
-t, --target string
該当する場合、使用するバンドルターゲット