account service-principalsコマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のaccount service-principalsコマンド グループには、サービスプリンシパルで作成、取得、一覧表示、更新、削除の操作を実行するコマンドが含まれています。 サービスシプリンパルは、ジョブ、自動化ツール、およびスクリプト、アプリ、 CI/CDプラットフォームなどのシステムで使用する ID です。 Databricks 、本番運用ジョブを実行するか、本番運用データを変更するためにサービスプリンシパルを作成することをお勧めします。 「サービスシプリンパル」を参照してください。
databricks アカウントサービスプリンシパル create
Databricksアカウントに新しいサービスプリンシパルを作成します。
databricks account service-principals create [flags]
オプション
--active
このサービスプリンシパルがアクティブな場合。
--application-id string
サービスプリンシパルに関連するUUID。
--display-name string
名と姓の連結を表す文字列。
--external-id string
サービスプリンシパルの外部ID。
--id string
DatabricksプリンシパルID。
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、コマンドライン フラグを使用してサービス プリンシパルを作成します。
databricks account service-principals create --application-id "12345678-1234-1234-1234-123456789abc" --display-name "CI/CD Pipeline"
次の例では、 JSONを使用してサービスプリンシパルを作成します。
databricks account service-principals create --json '{"applicationId": "12345678-1234-1234-1234-123456789abc", "displayName": "CI/CD Pipeline", "active": true}'
次の例では、 JSONファイルを使用してサービスプリンシパルを作成します。
databricks account service-principals create --json @service-principal.json
databricks アカウントサービスプリンシパル delete
Databricksアカウント内の 1 つのサービスプリンシパルを削除します。
databricks account service-principals delete ID [flags]
議論
ID
Databricksアカウント内のサービスプリンシパルの一意の ID。
オプション
例
次の例では、ID によってサービスプリンシパルを削除します。
databricks account service-principals delete 12345
databricks アカウントサービスプリンシパル get
Databricksアカウントで定義された単一のサービスプリンシパルの詳細を取得します。
databricks account service-principals get ID [flags]
議論
ID
Databricksアカウント内のサービスプリンシパルの一意の ID。
オプション
例
次の例では、ID によってサービスプリンシパルを取得します。
databricks account service-principals get 12345
databricks アカウントサービスプリンシパル一覧
Databricksアカウントに関連付けられたサービスプリンシパルのセットを取得します。
databricks account service-principals list [flags]
オプション
--attributes string
応答で返される属性のコンマ区切りリスト。
--count int
ページあたりの希望結果数。
--excluded-attributes string
応答で除外する属性のコンマ区切りリスト。
--filter string
結果をフィルタリングするクエリ。
--sort-by string
結果を並べ替える属性。
--sort-order ListSortOrder
結果を並べ替える順序。サポートされている値: ascending 、 descending 。
--start-index int
最初の結果のインデックスを指定します。
例
次の例では、すべてのサービスプリンシパルをリストします。
databricks account service-principals list
次の例では、ページネーションを使用してサービスプリンシパルをリストします。
databricks account service-principals list --count 10 --start-index 0
次の例では、フィルターを使用してサービスプリンシパルをリストします。
databricks account service-principals list --filter "displayName eq \"CI/CD Pipeline\""
databricks アカウントサービスプリンシパルパッチ
Databricksアカウント内の単一のサービスプリンパルシの詳細を部分的に更新します。
databricks account service-principals patch ID [flags]
議論
ID
Databricks ワークスペース内の一意の ID。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、 JSONを使用してサービスプリンシパルにパッチを適用します。
databricks account service-principals patch 12345 --json '{"displayName": "Updated CI/CD Pipeline"}'
次の例では、 JSONファイルを使用してサービスプリンシパルにパッチを適用します。
databricks account service-principals patch 12345 --json @patch-service-principal.json
databricks アカウントサービスプリンシパルアップデート
サービスプリンシパル エンティティ全体を置き換えることにより、単一のサービスプリンシパルの詳細を更新します。
databricks account service-principals update ID [flags]
議論
ID
DatabricksプリンシパルID。
オプション
--active
このサービスプリンシパルがアクティブな場合。
--application-id string
サービスプリンシパルに関連するUUID。
--display-name string
名と姓の連結を表す文字列。
--external-id string
サービスプリンシパルの外部ID。
--id string
DatabricksプリンシパルID。
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、コマンドライン フラグを使用してサービス プリンシパルを更新します。
databricks account service-principals update 12345 --display-name "Updated CI/CD Pipeline" --active
次の例では、 JSONを使用してサービスプリンシパルを更新します。
databricks account service-principals update 12345 --json '{"displayName": "Updated CI/CD Pipeline", "active": true}'
次の例では、 JSONファイルを使用してサービスプリンシパルを更新します。
databricks account service-principals update 12345 --json @update-service-principal.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
該当する場合、使用するバンドルターゲット