メインコンテンツまでスキップ

設定リファレンス

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

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

アーティファクト​

Type: Map

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

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

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

キー

タイプ

説明

build

文字列

デプロイ前にローカルで実行するビルド コマンドの省略可能なセット。

executable

文字列

実行可能ファイルの種類。 有効な値は、 bash、 sh、および cmdです。

files

順序

ビルドされたアーティファクトファイルへの相対パスまたは絶対パス。 アーティファクトを参照してください。 name.files です。

path

文字列

アーティファクトのディレクトリのローカルパス。

type

文字列

アーティファクトが Python wheelの場合に必要です。 アーティファクトのタイプ。 有効な値は whl と jarです。

例

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

アーティファクト. 名前 .files​

Type: Sequence

アーティファクトのソース ファイル。

キー

タイプ

説明

source

文字列

必須。 アーティファクト ソース ファイル。

バンドル​

Type: Map

このターゲットにデプロイするときのバンドル属性。

キー

タイプ

説明

cluster_id

文字列

バンドルの実行に使用するクラスターの ID。 クラスターを参照してください。

compute_id

文字列

廃止。 バンドルの実行に使用するコンピュートの ID。

databricks_cli_version

文字列

バンドルに使用する Databricks CLI のバージョン。 CLIを参照してください。

deployment

Map

バンドル・デプロイメントの定義。 サポートされている属性については 、「Databricks Asset Bundle デプロイ モード」を参照してください。 bundle.deployment を参照してください。

git

Map

バンドルに関連付けられている Git バージョン管理の詳細。 サポートされている属性については、 git を参照してください。 bundle.git を参照してください。

name

文字列

バンドルの名前。

uuid

文字列

引っ込み思案。 内部 Databricks システムでバンドルを一意に識別するバンドルの Universally Unique Identifier (UUID)。 これは、バンドル プロジェクトが Databricks テンプレート ( databricks bundle init コマンドを使用) を使用して初期化されるときに生成されます。

bundle.deploymentの​

Type: Map

バンドル・デプロイメントの定義

キー

タイプ

説明

fail_on_active_runs

ブール値

アクティブな実行で失敗するかどうか。 これを true に設定すると、実行中のデプロイメントが中断される可能性があります。

lock

Map

デプロイメント・ロック属性。 bundle.deployment.lockを参照してください。

bundle.deployment.lock​

Type: Map

デプロイメント・ロック属性。

キー

タイプ

説明

enabled

ブール値

このロックが有効になっているかどうか。

force

ブール値

このロックが有効な場合に、このロックを強制するかどうか。

バンドル.git​

Type: Map

バンドルに関連付けられている Git バージョン管理の詳細。

キー

タイプ

説明

branch

文字列

Git ブランチ名。 git を参照してください。

origin_url

文字列

リポジトリの元の URL。 git を参照してください。

実験的​

Type: Map

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

キー

タイプ

説明

pydabs

Map

PyDABsの設定。 experimental.pydabs を参照してください。

python

Map

'databricks-bundles' パッケージで定義された Python コードの読み込みを構成します。 実験的を参照してください。Python。

python_wheel_wrapper

ブール値

Python wheelラッパーを使用するかどうか。

scripts

Map

実行するコマンド。

use_legacy_run_as

ブール値

従来の実行動作を使用するかどうか。

experimental.pydabs​

Type: Map

PyDABsの設定。

キー

タイプ

説明

enabled

ブール値

PyDAB (Private Preview) が有効になっているかどうか。

import

順序

リソース、リソースジェネレーター、ミューテーターを検出するためにインポートする PyDABs プロジェクト。

venv_path

文字列

Python 仮想環境のパス。

実験的。Python​

Type: Map

'databricks-bundles' パッケージで定義された Python コードの読み込みを構成します。

キー

タイプ

説明

mutators

順序

Mutators には、 [my_project.mutators:add_default_cluster]などの mutator 関数への完全修飾関数パスのリストが含まれています。

resources

順序

リソースには、 Python コードで定義されたリソースをロードするための完全修飾関数パスのリストが含まれています。 ["my_project.resources:load_resources"]

venv_path

文字列

VEnvPath は仮想環境へのパスです。 有効にすると、Python コードはこの環境内で実行されます。 無効にすると、デフォルトでは現在のシェルで使用可能なPythonインタプリタが使用されます。

含める​

Type: Sequence

バンドルに含める構成ファイルを含むパス glob のリストを指定します。 「include」を参照してください。

権限​

Type: Sequence

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

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

キー

タイプ

説明

group_name

文字列

権限が level に設定されているグループの名前。

level

文字列

この権限に対して定義されている user, グループ, サービスプリンシパルの許可された権限。

service_principal_name

文字列

権限が level に設定されているサービスプリンシパルの名前。

user_name

文字列

権限が level に設定されているユーザーの名前。

例

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

プリセット​

Type: Map

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

キー

タイプ

説明

jobs_max_concurrent_runs

整数タイプ

ジョブの最大並列実行。

name_prefix

文字列

バンドルのジョブ実行のプレフィックス。

pipelines_development

ブール値

パイプラインのデプロイを開発モードでロックするかどうか。

source_linked_deployment

ブール値

デプロイメントをバンドル・ソースにリンクするかどうか。

tags

Map

バンドル展開のタグ。

trigger_pause_status

文字列

すべてのジョブ トリガーとスケジュールに適用する停止するステータス。 有効な値は 停止する または UNPAUSED です。

リソース​

Type: Map

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

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

キー

タイプ

説明

apps

Map

バンドルの Databricks アプリ定義 (各キーはアプリの名前です)。 アプリを参照してください。

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)を参照してください。

実行​

Type: Map

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

キー

タイプ

説明

service_principal_name

文字列

アクティブなサービスプリンシパルのアプリケーション ID。 このフィールドを設定するには、 servicePrincipal/user ロールが必要です。

user_name

文字列

アクティブなワークスペース ユーザーの Eメール 非管理者ユーザーは、このフィールドを自分の電子メールにのみ設定できます。

同期​

Type: Map

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

キー

タイプ

説明

exclude

順序

バンドルから除外するファイルまたはフォルダのリスト。

include

順序

バンドルに含めるファイルまたはフォルダのリスト。

paths

順序

バンドルのデプロイ時にワークスペースに同期するためのローカル フォルダー パス (バンドル ルートの外部に指定できます)。

ターゲット​

Type: Map

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

YAML
targets:
  <target-name>:
    <target-field-name>: <target-field-value>

キー

タイプ

説明

artifacts

Map

ターゲットデプロイメントに含めるアーティファクト。 「ターゲット」を参照してください。 name アーティファクト。

bundle

Map

このターゲットにデプロイするときのバンドル属性。 「ターゲット」を参照してください。 name.bundleです。

cluster_id

文字列

このターゲットに使用するクラスターの ID。

compute_id

文字列

廃止。 このターゲットに使用するコンピュートの ID。

default

ブール値

このターゲットがデフォルトのターゲットであるかどうか。

git

Map

ターゲットの Git バージョン管理設定。 「ターゲット」を参照してください。 name.git です。

mode

文字列

ターゲットのデプロイメント・モード。 有効な値は development または productionです。 「Databricks アセット バンドルのデプロイ モード」を参照してください。

permissions

順序

ターゲットにバンドルをデプロイおよび実行するための権限。 「ターゲット」を参照してください。 name.permissionsです。

presets

Map

ターゲットのデプロイメントプリセット。 「ターゲット」を参照してください。 name.presets です。

resources

Map

ターゲットのリソース定義。 「ターゲット」を参照してください。 name リソース。

run_as

Map

バンドルの実行に使用する ID については、「 Databricks Asset Bundles ワークフローの実行 ID を指定する」を参照してください。 「ターゲット」を参照してください。 name 実行。

sync

Map

バンドルが実行またはデプロイされるときにターゲット ワークスペースに同期するローカル パス。 「ターゲット」を参照してください。 name.sync です。

variables

Map

ターゲットのカスタム変数定義。 「ターゲット」を参照してください。 name.variablesです。

workspace

Map

ターゲットの Databricks ワークスペース。 「ターゲット」を参照してください。 name ワークスペース。

ターゲット。 名前 .アーティファクト​

Type: Map

ターゲットデプロイメントに含めるアーティファクト。

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

キー

タイプ

説明

build

文字列

デプロイ前にローカルで実行するためのデフォルト以外のビルド コマンドの省略可能なセット。

executable

文字列

実行可能ファイルの種類。 有効な値は、 bash、 sh、および cmdです。

files

順序

アーティファクトのソース ファイル。 「ターゲット」を参照してください。 name アーティファクト。 name.files です。

path

文字列

ビルドされたアーティファクトが保存される場所。

type

文字列

必須。 アーティファクトのタイプ。 有効な値は whlです。

ターゲット。 name アーティファクト。 名前 .files​

Type: Sequence

アーティファクトのソース ファイル。

キー

タイプ

説明

source

文字列

必須。 アーティファクトのビルドに使用されたファイルのパス。

ターゲット。 名前 .バンドル​

Type: Map

このターゲットにデプロイするときのバンドル属性。

キー

タイプ

説明

cluster_id

文字列

バンドルの実行に使用するクラスターの ID。 クラスターを参照してください。

compute_id

文字列

廃止。 バンドルの実行に使用するコンピュートの ID。

databricks_cli_version

文字列

バンドルに使用する Databricks CLI のバージョン。 CLIを参照してください。

deployment

Map

バンドル・デプロイメントの定義。 サポートされている属性については 、「Databricks Asset Bundle デプロイ モード」を参照してください。 「ターゲット」を参照してください。name.bundle.deploymentです。

git

Map

バンドルに関連付けられている Git バージョン管理の詳細。 サポートされている属性については、 git を参照してください。 「ターゲット」を参照してください。name.bundle.git です。

name

文字列

バンドルの名前。

uuid

文字列

引っ込み思案。 内部 Databricks システムでバンドルを一意に識別するバンドルの Universally Unique Identifier (UUID)。 これは、バンドル プロジェクトが Databricks テンプレート ( databricks bundle init コマンドを使用) を使用して初期化されるときに生成されます。

ターゲット。 名前 .bundle.deployment​

Type: Map

バンドル・デプロイメントの定義

キー

タイプ

説明

fail_on_active_runs

ブール値

アクティブな実行で失敗するかどうか。 これを true に設定すると、実行中のデプロイメントが中断される可能性があります。

lock

Map

デプロイメント・ロック属性。 「ターゲット」を参照してください。name.bundle.deployment.lock です。

ターゲット。 名前 .bundle.deployment.lock​

Type: Map

デプロイメント・ロック属性。

キー

タイプ

説明

enabled

ブール値

このロックが有効になっているかどうか。

force

ブール値

このロックが有効な場合に、このロックを強制するかどうか。

ターゲット。 名前 .bundle.git​

Type: Map

バンドルに関連付けられている Git バージョン管理の詳細。

キー

タイプ

説明

branch

文字列

Git ブランチ名。 git を参照してください。

origin_url

文字列

リポジトリの元の URL。 git を参照してください。

ターゲット。 名前 .git​

Type: Map

ターゲットの Git バージョン管理設定。

キー

タイプ

説明

branch

文字列

Git ブランチ名。 git を参照してください。

origin_url

文字列

リポジトリの元の URL。 git を参照してください。

ターゲット。 名前 .パーミッション​

Type: Sequence

ターゲットにバンドルをデプロイおよび実行するための権限。

キー

タイプ

説明

group_name

文字列

権限が level に設定されているグループの名前。

level

文字列

この権限に対して定義されている user, グループ, サービスプリンシパルの許可された権限。

service_principal_name

文字列

権限が level に設定されているサービスプリンシパルの名前。

user_name

文字列

権限が level に設定されているユーザーの名前。

ターゲット。 名前 .プリセット​

Type: Map

ターゲットのデプロイメントプリセット。

キー

タイプ

説明

jobs_max_concurrent_runs

整数タイプ

ジョブの最大並列実行。

name_prefix

文字列

バンドルのジョブ実行のプレフィックス。

pipelines_development

ブール値

パイプラインのデプロイを開発モードでロックするかどうか。

source_linked_deployment

ブール値

デプロイメントをバンドル・ソースにリンクするかどうか。

tags

Map

バンドル展開のタグ。

trigger_pause_status

文字列

すべてのジョブ トリガーとスケジュールに適用する停止するステータス。 有効な値は 停止する または UNPAUSED です。

ターゲット。 名前 .リソース​

Type: Map

ターゲットのリソース定義。

キー

タイプ

説明

apps

Map

バンドルの Databricks アプリ定義 (各キーはアプリの名前です)。 アプリを参照してください。

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)を参照してください。

ターゲット。 name 実行​

Type: Map

バンドルの実行に使用する ID。

キー

タイプ

説明

service_principal_name

文字列

アクティブなサービスプリンシパルのアプリケーション ID。 このフィールドを設定するには、 servicePrincipal/user ロールが必要です。

user_name

文字列

アクティブなワークスペース ユーザーの Eメール 非管理者ユーザーは、このフィールドを自分の電子メールにのみ設定できます。

ターゲット。 名前 .sync​

Type: Map

バンドルが実行またはデプロイされるときにターゲット ワークスペースに同期するローカル パス。

キー

タイプ

説明

exclude

順序

バンドルから除外するファイルまたはフォルダのリスト。

include

順序

バンドルに含めるファイルまたはフォルダのリスト。

paths

順序

バンドルのデプロイ時にワークスペースに同期するためのローカル フォルダー パス (バンドル ルートの外部に指定できます)。

ターゲット。 名前 .変数​

Type: Map

ターゲットのカスタム変数定義。

YAML
variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

キー

タイプ

説明

default

すべて

変数のデフォルト値。 これが指定されていない場合、

description

文字列

変数の説明。

lookup

Map

ID を取得するアラート、クラスタリング、クラスタリング、ダッシュボード、instance_pool、ジョブ、メタストア、パイプライン、クエリ、サービス、またはウェアハウス オブジェクトの名前。 「ターゲット」を参照してください。 name.variables です。 name.lookup です。

type

文字列

変数の型。

ターゲット。 name.variables です。 名前 .lookup​

Type: Map

ID を取得するアラート、クラスター、クラスター、ダッシュボード、instance_pool、ジョブ、メタストア、パイプライン、クエリ、サービス、またはウェアハウス オブジェクトの名前。

キー

タイプ

説明

alert

文字列

ID を取得するアラートの名前。

cluster

文字列

ID を取得するクラスターの名前。

cluster_policy

文字列

ID を取得するクラスターの名前。

dashboard

文字列

ID を取得するダッシュボードの名前。

instance_pool

文字列

ID を取得するinstance_poolの名前。

job

文字列

ID を取得するジョブの名前。

metastore

文字列

ID を取得するメタストアの名前。

notification_destination

文字列

ID を取得するnotification_destinationの名前。

pipeline

文字列

ID を取得するパイプラインの名前。

query

文字列

ID を取得するクエリの名前。

service_principal

文字列

ID を取得するサービスの名前。

warehouse

文字列

ID を取得するウェアハウスの名前。

ターゲット。 名前 .ワークスペース​

Type: Map

ターゲットの Databricks ワークスペース。

キー

タイプ

説明

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

文字列

ワークスペースの状態パス

変数​

Type: Map

バンドルのカスタム変数を定義します。 変数を参照してください。

YAML
variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

キー

タイプ

説明

default

すべて

変数のデフォルト値。

description

文字列

変数の説明

lookup

Map

ID を取得する alert、 cluster_policy、 cluster、 dashboard、 instance_pool、 job、 metastore、 pipeline、 query、 service_principal、または warehouse オブジェクトの名前。 変数を参照してください。 name.lookup です。

type

文字列

変数の型。

変数。 名前 .lookup​

Type: Map

ID を取得するアラート、クラスター、クラスター、ダッシュボード、instance_pool、ジョブ、メタストア、パイプライン、クエリ、サービス、またはウェアハウス オブジェクトの名前。

キー

タイプ

説明

alert

文字列

ID を取得するアラートの名前。

cluster

文字列

ID を取得するクラスターの名前。

cluster_policy

文字列

ID を取得するクラスターの名前。

dashboard

文字列

ID を取得するダッシュボードの名前。

instance_pool

文字列

ID を取得するinstance_poolの名前。

job

文字列

ID を取得するジョブの名前。

metastore

文字列

ID を取得するメタストアの名前。

notification_destination

文字列

ID を取得する notification_desination の名前。

pipeline

文字列

ID を取得するパイプラインの名前。

query

文字列

ID を取得するクエリの名前。

service_principal

文字列

ID を取得するサービスの名前。

warehouse

文字列

ID を取得するウェアハウスの名前。

ワークスペース​

Type: Map

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

キー

タイプ

説明

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

文字列

ワークスペースの状態パス

に最終更新