service-principals コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のservice-principalsコマンドグループを使用すると、Databricksワークスペースでサービスプリンシパルを管理できます。CI/CDはサービスプリンシパルを参照してください。
databricks service-principals create
新しいサービスプリンシパルを Databricks ワークスペースで作成します。
databricks 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 service-principals create --display-name "My Service Principal"
次の例では、 JSONを使用してサービスプリンシパルを作成します。
databricks service-principals create --json '{"display_name": "My Service Principal", "active": true}'
databricks service-principals delete
Databricks ワークスペースで 1 つのサービスプリンシパルを削除します。
databricks service-principals delete ID [flags]
引数
ID
Databricks ワークスペース内のサービスプリンシパルの一意の ID。
オプション
例
次の例では、サービスプリンシパルを ID で削除します。
databricks service-principals delete 12345
databricks service-principals get
Databricks ワークスペースで定義されている 1 つのサービスプリンシパルの詳細を取得します。
databricks service-principals get ID [flags]
引数
ID
Databricks ワークスペース内のサービスプリンシパルの一意の ID。
オプション
例
次の例では、サービスプリンシパルの詳細を取得します。
databricks service-principals get 12345
databricks service-principals list
Databricksワークスペースに関連付けられているサービスプリンシパルのセットをリストします。
databricks 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 service-principals list
次の例は、フィルタリングを使用したサービスプリンシパルをリストします。
databricks service-principals list --filter "displayName eq 'My Service Principal'"
databricks service-principals patch
Databricks ワークスペースで 1 つのサービスプリンシパルの詳細を部分的に更新します。
databricks service-principals patch ID [flags]
引数
ID
Databricks ワークスペースの一意の ID。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、サービスプリンシパルにパッチを適用します。
databricks service-principals patch 12345 --json '{"display_name": "Updated Service Principal"}'
databricks service-principals update
1 つのサービスプリンシパルの詳細を更新します。 このアクションにより、既存のサービスプリンシパルが同じ名前に置き換えられます。
databricks 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 service-principals update 12345 --display-name "Updated Service Principal" --active
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット