設定リファレンス

この記事では、Databricks Asset Bundles 構成 (YAML) でサポートされるキーのリファレンスを提供します。 「Databricks アセットバンドルとは」を参照してください。

完全なバンドルの例については、 バンドル設定の例 と bundle-examples GitHub リポジトリを参照してください。

アーティファクト

アーティファクトを構築するための設定を定義します。

キー	タイプ	説明
build	String	デプロイ前にローカルで実行するためのデフォルト以外のビルド コマンドの省略可能なセット。
executable	String	実行可能ファイルの種類。 有効な値は、 bash、 sh、および cmdです。
files	Map	アーティファクトとして定義されるアーティファクトのソース ファイル。
path	String	ビルドされたアーティファクトが保存される場所。
type	String	必須。 アーティファクトのタイプ。 有効な値は whlです。

アーティファクト

アーティファクトをビルドする属性を定義します。各キーはアーティファクトの名前で、値は アーティファクトのビルド設定を定義するマップです。 artifactsマッピングに関する情報については、アーティファクトを参照してください。

バンドル構成の最上位レベルで定義されたアーティファクト設定は、 targets マッピングでオーバーライドできます。 「Databricks アセットバンドルでのアーティファクト設定の定義」を参照してください。

artifacts:
  <artifact-name>:
      <artifact-field-name>: <artifact-field-value>

例

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

アーティファクト

バンドル内のアーティファクト・ファイルを定義します。

キー	タイプ	説明
source	String	必須。 アーティファクトのビルドに使用されたファイルのパス。

bundle

バンドルの属性。 バンドルを参照してください。

キー	タイプ	説明
cluster_id	String	バンドルの実行に使用するクラスタリングの ID。 クラスタリングを参照してください。
databricks_cli_version	String	バンドルに使用する Databricks CLI のバージョン。 CLIを参照してください。
deployment	Map	バンドル・デプロイメントの定義。 サポートされている属性については、「 デプロイ 」と 「Databricks アセット バンドルのデプロイ モード」を参照してください。
git	Map	バンドルに関連付けられている Git バージョン管理の詳細。 サポートされている属性については、「 git 」と「 git」を参照してください。
name	String	必須。 バンドルの名前。

配備

バンドル・デプロイメント属性を定義します。

キー	タイプ	説明
fail_on_active_runs	ブール値	アクティブな実行で失敗するかどうか。 これを true に設定すると、実行中のデプロイが中断される可能性があります。
lock	Map	デプロイメント・ロック属性。 「ロック」を参照してください。

実験的

実験的な機能の属性を定義します。

キー	タイプ	説明
python_wheel_wrapper	ブール値	Python wheelラッパーを使用するかどうか。
scripts	コマンド (文字列)	実行するコマンド
use_legacy_run_as	ブール値	従来の実行動作を使用するかどうか。

git

バンドルに関連付けられている Git バージョン管理の詳細を定義します。 git を参照してください。

キー	タイプ	説明
origin_url	String	リポジトリの元の URL。 git を参照してください。
branch	String	Git ブランチ名。 git を参照してください。

叶える

Unity Catalog オブジェクトへのアクセスを定義します。 詳細については、「Unity Catalogを使用したクラウド オブジェクト ストレージへの接続」を参照してください。

キー	タイプ	説明
principal	String	必須。 権限を付与されるプリンシパルの名前。
privileges	String	必須。 指定したエンティティに付与する特権。

例

次の例では、許可を使用して Unity Catalog スキーマを定義しています。

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

錠

バンドル・デプロイメント・ロック属性を定義します。

キー	タイプ	説明
enabled	ブール値	このロックが有効になっているかどうか。
force	ブール値	このロックが有効な場合に、このロックを強制するかどうか。

許可

特定のエンティティのアクセス許可を定義します。 「Databricks アセット バンドルのリソースのアクセス許可を設定する」と「アクセス許可を設定する 」を参照してください。

キー	タイプ	説明
group_name	String	levelでアクセス権が設定されているグループの名前。
level	String	必須。 この権限に対して定義されている user, グループ, サービスプリンシパルの許可された権限。
service_principal_name	String	levelで権限が設定されているサービスプリンシパルの名前。
user_name	String	levelで権限が設定されているユーザーの名前。

権限

バンドルで定義されたエクスペリメント、ジョブ、パイプライン、およびモデルに適用するアクセス許可を定義するシーケンス (シーケンス内の各アイテムは特定のエンティティの アクセス許可 です)。

「Databricks アセット バンドルのリソースのアクセス許可を設定する」と「アクセス許可を設定する 」を参照してください。

例

permissions:
  - level: CAN_VIEW
    group_name: test-group
  - level: CAN_MANAGE
    user_name: someone@example.com
  - level: CAN_RUN
    service_principal_name: 123456-abcdef

プリセット

バンドルデプロイメントプリセットを定義します。 「カスタムプリセット」を参照してください。

キー	タイプ	説明
jobs_max_concurrent_runs	Integer	ジョブの最大並列実行。
name_prefix	String	バンドルのジョブ実行のプレフィックス。
pipelines_development	ブール値	パイプラインのデプロイを開発モードでロックするかどうか。
source_linked_deployment	ブール値	デプロイメントをバンドル・ソースにリンクするかどうか。
tags	Map	バンドル展開のタグ。
trigger_pause_status	String	すべてのジョブ トリガーとスケジュールに適用する停止するステータス。 有効な値は PAUSED または UNPAUSEDです。

リソース

バンドルのリソースを定義する Map (各キーはリソースの名前、値はリソースを定義する Map) です。 アセットバンドルでサポートされているDatabricksリソース、およびリソース定義リファレンスの詳細については、「アセットバンドルDatabricksリソース」を参照してください。

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

キー	タイプ	説明
clusters	Map	バンドルのクラスタリング定義 (各キーはクラスタリングの名前です)。 「クラスタリング」を参照してください。
dashboards	Map	バンドルのダッシュボード定義 (各キーはダッシュボードの名前です)。 ダッシュボードを見る
experiments	Map	バンドルのエクスペリメント定義 (各キーはエクスペリメントの名前です)。 エクスペリメントを参照してください
jobs	Map	バンドルのジョブ定義 (各キーはジョブの名前です)。 ジョブを見る
model_serving_endpoints	Map	バンドルのモデルサービングエンドポイント定義 (各キーはモデルサービングエンドポイントの名前です)。 model_serving_endpointを見る
models	Map	バンドルのモデル定義 (各キーはモデルの名前です)。 モデル(レガシー)を見る
pipelines	Map	バンドルのパイプライン定義 (各キーはパイプラインの名前です)。 パイプラインを見る
quality_monitors	Map	バンドルの品質モニター定義 (各キーは品質モニターの名前です)。 quality_monitor (Unity Catalog) を参照してください。
registered_models	Map	バンドルの登録済みモデル定義 (各キーは Unity Catalog 登録済みモデルの名前です)。 registered_model (Unity Catalog) を参照してください。
schemas	Map	バンドルのスキーマ定義 (各キーはスキーマの名前です)。 スキーマ(Unity Catalogを参照)
volumes	Map	バンドルのボリューム定義 (各キーはボリュームの名前です)。 「ボリューム (Unity Catalog) を見る

実行

Databricks Asset Bundles ワークフローを実行するときに使用する ID。 「Databricks Asset Bundles ワークフローの実行 ID を指定する」を参照してください。

キー	タイプ	説明
service_principal_name	String	アクティブなサービスプリンシパルのアプリケーション ID。 このフィールドを設定するには、 servicePrincipal/user ロールが必要です。
user_name	String	アクティブなワークスペース ユーザーの Eメール 非管理者ユーザーは、このフィールドを自分の電子メールにのみ設定できます。

同期

バンドルに含める、またはバンドルから除外するファイルとファイルパス。 「同期」を参照してください。

キー	タイプ	説明
exclude	順序	バンドルから除外するファイルまたはフォルダのリスト。
include	順序	バンドルに含めるファイルまたはフォルダのリスト。
paths	順序	バンドルのデプロイ時にワークスペースに同期するためのローカル フォルダー パス (バンドル ルートの外部に指定できます)。

ターゲット

バンドルのデプロイメント・ターゲットを定義します。 ターゲットを見る

キー	タイプ	説明
artifacts	Map	ターゲットデプロイメントに含めるアーティファクト。 アーティファクトを参照してください。
bundle	Map	このターゲットにデプロイするときのバンドル属性。
cluster_id	String	このターゲットに使用するクラスタリングの ID。
compute_id	String	廃止。 このターゲットに使用するコンピュートの ID。
default	ブール値	このターゲットがデフォルトのターゲットであるかどうか。
git	Map	ターゲットの Git バージョン管理設定。 git を参照してください。
mode	String	ターゲットのデプロイメント・モード。 有効な値は development または productionです。 「Databricks アセット バンドルのデプロイ モード」を参照してください。
permissions	順序	ターゲットにバンドルをデプロイおよび実行するための権限。 「パーミッション」を参照してください。
presets	Map	ターゲットのデプロイメントプリセット。 「プリセット」を参照してください。
resources	Map	ターゲットのリソース定義。 「リソース」を参照してください。
run_as	Map	バンドルの実行に使用する ID。 「実行」および「Databricks Asset Bundles ワークフローの実行 ID の指定」を参照してください。
sync	Map	バンドルが実行またはデプロイされるときにターゲット ワークスペースに同期するローカル パス。 「同期」を参照してください。
variables	Map	ターゲットのカスタム変数定義。 「変数」および「Databricks アセットバンドルの置換と変数」を参照してください。
workspace	Map	ターゲットの Databricks ワークスペース。 ワークスペース

変数

バンドルのカスタム変数を定義する Map (各キーは変数の名前、値は変数を定義する Map) です。 「Databricks アセット バンドルの置換と変数」を参照してください。

キー	タイプ	説明
変数名	Map	変数の定義。 variable-nameを参照してください。

変数名

各変数定義には、次の属性があります。

キー	タイプ	説明
description	String	変数の説明。
lookup	String	ID を取得する alert、 cluster_policy、 cluster、 dashboard、 instance_pool、 job、 metastore、 pipeline、 query、 service_principal、または warehouse オブジェクトの名前。
type	String	変数の型。 有効な値は complexです。

ワークスペース

バンドルの Databricks ワークスペースを定義します。 ワークスペースを参照してください。

キー	タイプ	説明
artifact_path	String	デプロイとワークフロー実行の両方に対してワークスペース内で使用するアーティファクト パス
auth_type	String	認証の種類。
azure_client_id	String	Azure クライアント ID。
azure_environment	String	Azure 環境。
azure_login_app_id	String	Azure ログイン アプリ ID。
azure_tenant_id	String	Azure テナント ID。
azure_use_msi	ブール値	Azure に MSI を使用するかどうか。
azure_workspace_resource_id	String	Azure ワークスペース リソース ID。
client_id	String	ワークスペースのクライアント ID。
file_path	String	デプロイとワークフロー実行の両方でワークスペース内で使用するファイル パス。
google_service_account	String	Google サービス アカウント名。
host	String	Databricks ワークスペースのホスト URL。
profile	String	Databricks ワークスペース プロファイル名。
resource_path	String	ワークスペースのリソースパス。
root_path	String	Databricks ワークスペースのルート パス。
state_path	String	ワークスペースの状態パス。