次の方法で共有

構成参照

  • [アーティクル]

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

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

artifact

成果物をビルドするための設定を定義します。

キー タイプ 説明
build 文字列 デプロイ前にローカルで実行するビルド コマンドのオプション セット。
executable 文字列 実行可能ファイルの種類。 有効な値は bash、sh、cmd です。
files マップ artifact_fileとして定義されている、ビルドされた成果物ファイルへの相対パスまたは絶対パス。
path 文字列 成果物のディレクトリのローカル パス。
type 文字列 アーティファクトが Python ホイールの場合は必須。 成果物の種類。 有効な値は whl と jar です。

artifacts

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

バンドル構成の最上位レベルで定義されている成果物設定は、targets マッピングでオーバーライドできます。 Databricks Asset Bundles で成果物設定を定義するを参照してください。

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

例

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

artifact_file

バンドル内の成果物ファイルを定義します。

キー タイプ 説明
source 文字列 必須。 成果物ソース ファイル。

bundle

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

キー タイプ 説明
cluster_id 文字列 バンドルの実行に使用するクラスターの ID。 cluster_idを参照してください。
databricks_cli_version 文字列 バンドルに使用する Databricks CLI バージョン。 「databricks_cli_version」を参照してください。
deployment マップ バンドルデプロイの定義。 サポートされている属性については、デプロイ と Databricks アセット バンドルのデプロイ モード を参照してください。
git マップ バンドルに関連付けられている Git バージョン コントロールの詳細。 サポートされている属性については、git の と git のを参照してください。
name 文字列 必須。 バンドルの名前。
uuid 文字列 予約済み。 Databricks の内部システムでバンドルを一意に識別するためのユニバーサルユニーク識別子 (UUID)。 これは、バンドル プロジェクトが Databricks テンプレートを使用して初期化されるときに生成されます (databricks bundle init コマンドを使用)。

deployment

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

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

experimental

試験段階の特徴の属性を定義します。

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

git

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

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

grant

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

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

例

次の例では、grant を使用して Unity カタログ スキーマを定義します。

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"

lock

バンドル展開ロック属性を定義します。

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

permission

特定のエンティティのアクセス許可を定義します。 Databricks Asset Bundles のリソースに対する権限の設定については の権限とを参照してください。

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

permissions

バンドルで定義されている実験、ジョブ、パイプライン、モデルに適用するアクセス許可を定義するシーケンス。シーケンス内の各項目は、特定のエンティティに対する アクセス許可 です。

「permissions」および「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 整数 ジョブの同時実行の最大数。
name_prefix 文字列 バンドルのジョブ実行のプレフィックス。
pipelines_development ブール値 パイプラインデプロイを開発モードでロックする必要があるかどうか。
source_linked_deployment ブール値 デプロイをバンドル ソースにリンクするかどうか。
tags マップ バンドルデプロイのタグ。
trigger_pause_status 文字列 すべてのジョブ トリガーとスケジュールに適用する一時停止状態。 有効な値は PAUSED または UNPAUSED です。

resources

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

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
キー タイプ 説明
clusters マップ バンドルのクラスター定義。各キーはクラスターの名前です。 クラスター の を参照
dashboards マップ バンドルのダッシュボード定義。各キーはダッシュボードの名前です。 ダッシュボード を参照してください
experiments マップ バンドルの実験定義。各キーは実験の名前です。 実験 参照
jobs マップ バンドルのジョブ定義。各キーはジョブの名前です。 「job」を参照してください
model_serving_endpoints マップ バンドルのエンドポイント定義を提供するモデル。各キーは、エンドポイントを提供するモデルの名前です。 「model_serving_endpoint」を参照してください
models マップ バンドルのモデル定義。各キーはモデルの名前です。 モデル（レガシー）を参照
pipelines マップ バンドルのパイプライン定義。各キーはパイプラインの名前です。 「pipeline」を参照してください
quality_monitors マップ バンドルの品質モニター定義。各キーは品質モニターの名前です。 「quality_monitor (Unity Catalog)」を参照してください
registered_models マップ バンドルの登録済みモデル定義。各キーは Unity カタログ登録済みモデルの名前です。 「registered_model (Unity Catalog)」を参照してください
schemas マップ バンドルのスキーマ定義。各キーはスキーマの名前です。 スキーマ (Unity カタログ) を参照してください
volumes マップ バンドルのボリューム定義。各キーはボリュームの名前です。 「volume (Unity Catalog)」を参照してください

run_as

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

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

sync

バンドルに含めるか除外するファイルとファイル パス。 「sync」を参照してください。

キー タイプ 説明
exclude シーケンス バンドルから除外するファイルまたはフォルダーの一覧。
include シーケンス バンドルに含めるファイルまたはフォルダーの一覧。
paths シーケンス バンドルのデプロイ時にワークスペースに同期するローカル フォルダー パス (バンドル ルートの外部にある場合があります)。

目標

バンドルのデプロイ ターゲットを定義します。 「targets」を参照してください

キー タイプ 説明
artifacts マップ ターゲット デプロイに含める成果物。 「artifacts」を参照してください。
bundle マップ このターゲットにデプロイするときのバンドル属性。
cluster_id 文字列 このターゲットに使用するクラスターの ID。
compute_id 文字列 非推奨になりました。 このターゲットに使用するコンピューティングの ID。
default ブール値 このターゲットが既定のターゲットかどうか。
git マップ ターゲットの Git バージョン管理設定。 gitを参照してください。
mode 文字列 ターゲットのデプロイ モード。 有効な値は development または production です。 Databricks アセット バンドルのデプロイ モードを参照してください。
permissions シーケンス ターゲットでバンドルをデプロイして実行するためのアクセス許可。 「permissions」を参照してください。
presets マップ ターゲットのデプロイ プリセット。 プリセット を参照してください。
resources マップ ターゲットのリソース定義。 リソースを参照してください。
run_as マップ バンドルの実行に使用する ID。 「run_as と Databricks Asset Bundles ワークフローの実行 ID を指定する」を参照してください。
sync マップ バンドルの実行時またはデプロイ時にターゲット ワークスペースに同期するローカル パス。 「sync」を参照してください。
variables マップ ターゲットのカスタム変数定義。 「variables」および「Databricks アセット バンドルの置換と変数」を参照してください。
workspace マップ ターゲットの Databricks ワークスペース。 workspace

variables

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

キー タイプ 説明
変数名 マップ 変数の定義。 変数名 を参照してください。

変数名

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

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

workspace

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

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