steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Re-generate doc after merge

This commit is contained in:
Ilya Kuznetsov 2025-02-24 17:26:05 +01:00
parent f49641e79e
commit 8c36b93614
No known key found for this signature in database
GPG Key ID: 91F3DDCF5D21CDDF
2 changed files with 4689 additions and 3809 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

339
bundle/docsgen/output/reference.md
View File

@ -1,5 +1,5 @@
--- ---
description: Configuration reference for databricks.yml description: "Configuration reference for databricks.yml"
--- ---
<!-- DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli --> <!-- DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli -->
@ -10,13 +10,14 @@ This article provides reference for keys supported by Databricks Asset Bundles c
For complete bundle examples, see [\_](/dev-tools/bundles/resource-examples.md) and the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples). For complete bundle examples, see [\_](/dev-tools/bundles/resource-examples.md) and the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples).
## artifacts ## artifacts
**`Type: Map`** **`Type: Map`**
Defines the attributes to build artifacts, where each key is the name of the artifact, and the value is a Map that defines the artifact build settings. For information about the `artifacts` mapping, see [\_](/dev-tools/bundles/settings.md#artifacts). Defines the attributes to build artifacts, where each key is the name of the artifact, and the value is a Map that defines the artifact build settings. For information about the `artifacts` mapping, see [_](/dev-tools/bundles/settings.md#artifacts).
Artifact settings defined in the top level of the bundle configuration can be overridden in the `targets` mapping. See [\_](/dev-tools/bundles/artifact-overrides.md). Artifact settings defined in the top level of the bundle configuration can be overridden in the `targets` mapping. See [_](/dev-tools/bundles/artifact-overrides.md).
```yaml ```yaml
artifacts: artifacts:
@ -24,6 +25,7 @@ artifacts:
<artifact-field-name>: <artifact-field-value> <artifact-field-name>: <artifact-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
@ -38,13 +40,9 @@ artifacts:
- String - String
- The executable type. Valid values are `bash`, `sh`, and `cmd`. - The executable type. Valid values are `bash`, `sh`, and `cmd`.
<<<<<<< HEAD
- - `files` - - `files`
- Sequence - Sequence
- # The source files for the artifact. See [\_](#artifactsnamefiles). - The source files for the artifact. See [_](#artifactsnamefiles).
* - `files` - Sequence - The source files for the artifact. See [\_](#artifactsnamefiles).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `path` - - `path`
- String - String
@ -56,6 +54,7 @@ artifacts:
::: :::
**Example** **Example**
```yaml ```yaml
@ -72,6 +71,8 @@ artifacts:
The source files for the artifact. The source files for the artifact.
:::list-table :::list-table
- - Key - - Key
@ -84,12 +85,15 @@ The source files for the artifact.
::: :::
## bundle ## bundle
**`Type: Map`** **`Type: Map`**
The bundle attributes when deploying to this target, The bundle attributes when deploying to this target,
:::list-table :::list-table
- - Key - - Key
@ -98,7 +102,7 @@ The bundle attributes when deploying to this target,
- - `cluster_id` - - `cluster_id`
- String - String
- The ID of a cluster to use to run the bundle. See [\_](/dev-tools/bundles/settings.md#cluster_id). - The ID of a cluster to use to run the bundle. See [_](/dev-tools/bundles/settings.md#cluster_id).
- - `compute_id` - - `compute_id`
- String - String
@ -106,25 +110,15 @@ The bundle attributes when deploying to this target,
- - `databricks_cli_version` - - `databricks_cli_version`
- String - String
- The Databricks CLI version to use for the bundle. See [\_](/dev-tools/bundles/settings.md#databricks_cli_version). - The Databricks CLI version to use for the bundle. See [_](/dev-tools/bundles/settings.md#databricks_cli_version).
<<<<<<< HEAD
- - `deployment` - - `deployment`
- Map - Map
- The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). See [\_](#bundledeployment). - The definition of the bundle deployment. For supported attributes see [_](/dev-tools/bundles/deployment-modes.md). See [_](#bundledeployment).
- - `git` - - `git`
- Map - Map
- # The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). See [\_](#bundlegit). - The Git version control details that are associated with your bundle. For supported attributes see [_](/dev-tools/bundles/settings.md#git). See [_](#bundlegit).
* - `deployment`
- Map
- The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). See [\_](#bundledeployment).
* - `git` - Map - The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). See [\_](#bundlegit).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `name` - - `name`
- String - String
@ -136,11 +130,14 @@ The bundle attributes when deploying to this target,
::: :::
### bundle.deployment ### bundle.deployment
**`Type: Map`** **`Type: Map`**
The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). The definition of the bundle deployment. For supported attributes see [_](/dev-tools/bundles/deployment-modes.md).
:::list-table :::list-table
@ -152,16 +149,12 @@ The definition of the bundle deployment. For supported attributes see [\_](/dev-
- Boolean - Boolean
- Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted. - Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.
<<<<<<< HEAD
- - `lock` - - `lock`
- Map - Map
- The deployment lock attributes. See [\_](#bundledeploymentlock). - The deployment lock attributes. See [_](#bundledeploymentlock).
# ::: :::
- - `lock` - Map - The deployment lock attributes. See [\_](#bundledeploymentlock).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
### bundle.deployment.lock ### bundle.deployment.lock
@ -169,6 +162,8 @@ The definition of the bundle deployment. For supported attributes see [\_](/dev-
The deployment lock attributes. The deployment lock attributes.
:::list-table :::list-table
- - Key - - Key
@ -185,11 +180,14 @@ The deployment lock attributes.
::: :::
### bundle.git ### bundle.git
**`Type: Map`** **`Type: Map`**
The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). The Git version control details that are associated with your bundle. For supported attributes see [_](/dev-tools/bundles/settings.md#git).
:::list-table :::list-table
@ -199,43 +197,36 @@ The Git version control details that are associated with your bundle. For suppor
- - `branch` - - `branch`
- String - String
- The Git branch name. See [\_](/dev-tools/bundles/settings.md#git). - The Git branch name. See [_](/dev-tools/bundles/settings.md#git).
- - `origin_url` - - `origin_url`
- String - String
- The origin URL of the repository. See [\_](/dev-tools/bundles/settings.md#git). - The origin URL of the repository. See [_](/dev-tools/bundles/settings.md#git).
::: :::
## experimental ## experimental
**`Type: Map`** **`Type: Map`**
Defines attributes for experimental features. Defines attributes for experimental features.
:::list-table :::list-table
- - Key - - Key
- Type - Type
- Description - Description
<<<<<<< HEAD
- - `pydabs` - - `pydabs`
- Map - Map
- The PyDABs configuration. See [\_](#experimentalpydabs). - The PyDABs configuration. See [_](#experimentalpydabs).
- - `python` - - `python`
- Map - Map
- # Configures loading of Python code defined with 'databricks-bundles' package. See [\_](#experimentalpython). - Configures loading of Python code defined with 'databricks-bundles' package. See [_](#experimentalpython).
* - `pydabs`
- Map
- The PyDABs configuration. See [\_](#experimentalpydabs).
* - `python` - Map - Configures loading of Python code defined with 'databricks-bundles' package. See [\_](#experimentalpython).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `python_wheel_wrapper` - - `python_wheel_wrapper`
- Boolean - Boolean
@ -251,12 +242,15 @@ Defines attributes for experimental features.
::: :::
### experimental.pydabs ### experimental.pydabs
**`Type: Map`** **`Type: Map`**
The PyDABs configuration. The PyDABs configuration.
:::list-table :::list-table
- - Key - - Key
@ -277,12 +271,15 @@ The PyDABs configuration.
::: :::
### experimental.python ### experimental.python
**`Type: Map`** **`Type: Map`**
Configures loading of Python code defined with 'databricks-bundles' package. Configures loading of Python code defined with 'databricks-bundles' package.
:::list-table :::list-table
- - Key - - Key
@ -303,11 +300,13 @@ Configures loading of Python code defined with 'databricks-bundles' package.
::: :::
## include ## include
**`Type: Sequence`** **`Type: Sequence`**
Specifies a list of path globs that contain configuration files to include within the bundle. See [\_](/dev-tools/bundles/settings.md#include) Specifies a list of path globs that contain configuration files to include within the bundle. See [_](/dev-tools/bundles/settings.md#include)
## permissions ## permissions
@ -315,7 +314,9 @@ Specifies a list of path globs that contain configuration files to include withi
A Sequence that defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle, where each item in the sequence is a permission for a specific entity. A Sequence that defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle, where each item in the sequence is a permission for a specific entity.
See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
:::list-table :::list-table
@ -341,6 +342,7 @@ See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles
::: :::
**Example** **Example**
```yaml ```yaml
@ -357,7 +359,9 @@ permissions:
**`Type: Map`** **`Type: Map`**
Defines bundle deployment presets. See [\_](/dev-tools/bundles/deployment-modes.md#presets). Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.md#presets).
:::list-table :::list-table
@ -391,11 +395,12 @@ Defines bundle deployment presets. See [\_](/dev-tools/bundles/deployment-modes.
::: :::
## resources ## resources
**`Type: Map`** **`Type: Map`**
A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about Databricks Asset Bundles supported resources, and resource definition reference, see [\_](/dev-tools/bundles/resources.md). A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about Databricks Asset Bundles supported resources, and resource definition reference, see [_](/dev-tools/bundles/resources.md).
```yaml ```yaml
resources: resources:
@ -404,6 +409,8 @@ resources:
<resource-field-name>: <resource-field-value> <resource-field-name>: <resource-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
@ -416,55 +423,58 @@ resources:
- - `clusters` - - `clusters`
- Map - Map
- The cluster definitions for the bundle, where each key is the name of a cluster. See [\_](/dev-tools/bundles/resources.md#clusters) - The cluster definitions for the bundle, where each key is the name of a cluster. See [_](/dev-tools/bundles/resources.md#clusters)
- - `dashboards` - - `dashboards`
- Map - Map
- The dashboard definitions for the bundle, where each key is the name of the dashboard. See [\_](/dev-tools/bundles/resources.md#dashboards) - The dashboard definitions for the bundle, where each key is the name of the dashboard. See [_](/dev-tools/bundles/resources.md#dashboards)
- - `experiments` - - `experiments`
- Map - Map
- The experiment definitions for the bundle, where each key is the name of the experiment. See [\_](/dev-tools/bundles/resources.md#experiments) - The experiment definitions for the bundle, where each key is the name of the experiment. See [_](/dev-tools/bundles/resources.md#experiments)
- - `jobs` - - `jobs`
- Map - Map
- The job definitions for the bundle, where each key is the name of the job. See [\_](/dev-tools/bundles/resources.md#jobs) - The job definitions for the bundle, where each key is the name of the job. See [_](/dev-tools/bundles/resources.md#jobs)
- - `model_serving_endpoints` - - `model_serving_endpoints`
- Map - Map
- The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [\_](/dev-tools/bundles/resources.md#model_serving_endpoints) - The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [_](/dev-tools/bundles/resources.md#model_serving_endpoints)
- - `models` - - `models`
- Map - Map
- The model definitions for the bundle, where each key is the name of the model. See [\_](/dev-tools/bundles/resources.md#models) - The model definitions for the bundle, where each key is the name of the model. See [_](/dev-tools/bundles/resources.md#models)
- - `pipelines` - - `pipelines`
- Map - Map
- The pipeline definitions for the bundle, where each key is the name of the pipeline. See [\_](/dev-tools/bundles/resources.md#pipelines) - The pipeline definitions for the bundle, where each key is the name of the pipeline. See [_](/dev-tools/bundles/resources.md#pipelines)
- - `quality_monitors` - - `quality_monitors`
- Map - Map
- The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [\_](/dev-tools/bundles/resources.md#quality_monitors) - The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [_](/dev-tools/bundles/resources.md#quality_monitors)
- - `registered_models` - - `registered_models`
- Map - Map
- The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [\_](/dev-tools/bundles/resources.md#registered_models) - The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [_](/dev-tools/bundles/resources.md#registered_models)
- - `schemas` - - `schemas`
- Map - Map
- The schema definitions for the bundle, where each key is the name of the schema. See [\_](/dev-tools/bundles/resources.md#schemas) - The schema definitions for the bundle, where each key is the name of the schema. See [_](/dev-tools/bundles/resources.md#schemas)
- - `volumes` - - `volumes`
- Map - Map
- The volume definitions for the bundle, where each key is the name of the volume. See [\_](/dev-tools/bundles/resources.md#volumes) - The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volumes)
::: :::
## run_as ## run_as
**`Type: Map`** **`Type: Map`**
The identity to use when running Databricks Asset Bundles workflows. See [\_](/dev-tools/bundles/run-as.md). The identity to use when running Databricks Asset Bundles workflows. See [_](/dev-tools/bundles/run-as.md).
:::list-table :::list-table
@ -482,11 +492,14 @@ The identity to use when running Databricks Asset Bundles workflows. See [\_](/d
::: :::
## sync ## sync
**`Type: Map`** **`Type: Map`**
The files and file paths to include or exclude in the bundle. See [\_](/dev-tools/bundles/settings.md#sync). The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/settings.md#sync).
:::list-table :::list-table
@ -508,11 +521,12 @@ The files and file paths to include or exclude in the bundle. See [\_](/dev-tool
::: :::
## targets ## targets
**`Type: Map`** **`Type: Map`**
Defines deployment targets for the bundle. See [\_](/dev-tools/bundles/settings.md#targets) Defines deployment targets for the bundle. See [_](/dev-tools/bundles/settings.md#targets)
```yaml ```yaml
targets: targets:
@ -520,29 +534,20 @@ targets:
<target-field-name>: <target-field-value> <target-field-name>: <target-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
- Type - Type
- Description - Description
<<<<<<< HEAD
- - `artifacts` - - `artifacts`
- Map - Map
- The artifacts to include in the target deployment. See [\_](#targetsnameartifacts). - The artifacts to include in the target deployment. See [_](#targetsnameartifacts).
- - `bundle` - - `bundle`
- Map - Map
- # The bundle attributes when deploying to this target. See [\_](#targetsnamebundle). - The bundle attributes when deploying to this target. See [_](#targetsnamebundle).
* - `artifacts`
- Map
- The artifacts to include in the target deployment. See [\_](#targetsnameartifacts).
* - `bundle` - Map - The bundle attributes when deploying to this target. See [\_](#targetsnamebundle).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `cluster_id` - - `cluster_id`
- String - String
@ -556,76 +561,44 @@ targets:
- Boolean - Boolean
- Whether this target is the default target. - Whether this target is the default target.
<<<<<<< HEAD
- - `git` - - `git`
- Map - Map
- # The Git version control settings for the target. See [\_](#targetsnamegit). - The Git version control settings for the target. See [_](#targetsnamegit).
* - `git` - Map - The Git version control settings for the target. See [\_](#targetsnamegit).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `mode` - - `mode`
- String - String
- The deployment mode for the target. Valid values are `development` or `production`. See [\_](/dev-tools/bundles/deployment-modes.md). - The deployment mode for the target. Valid values are `development` or `production`. See [_](/dev-tools/bundles/deployment-modes.md).
<<<<<<< HEAD
- - `permissions` - - `permissions`
- Sequence - Sequence
- The permissions for deploying and running the bundle in the target. See [\_](#targetsnamepermissions). - The permissions for deploying and running the bundle in the target. See [_](#targetsnamepermissions).
- - `presets` - - `presets`
- Map - Map
- The deployment presets for the target. See [\_](#targetsnamepresets). - The deployment presets for the target. See [_](#targetsnamepresets).
- - `resources` - - `resources`
- Map - Map
- The resource definitions for the target. See [\_](#targetsnameresources). - The resource definitions for the target. See [_](#targetsnameresources).
- - `run_as` - - `run_as`
- Map - Map
- The identity to use to run the bundle, see [\_](/dev-tools/bundles/run-as.md). See [\_](#targetsnamerun_as). - The identity to use to run the bundle, see [_](/dev-tools/bundles/run-as.md). See [_](#targetsnamerun_as).
- - `sync` - - `sync`
- Map - Map
- The local paths to sync to the target workspace when a bundle is run or deployed. See [\_](#targetsnamesync). - The local paths to sync to the target workspace when a bundle is run or deployed. See [_](#targetsnamesync).
- - `variables` - - `variables`
- Map - Map
- The custom variable definitions for the target. See [\_](#targetsnamevariables). - The custom variable definitions for the target. See [_](#targetsnamevariables).
- - `workspace` - - `workspace`
- Map - Map
- The Databricks workspace for the target. See [\_](#targetsnameworkspace). - The Databricks workspace for the target. See [_](#targetsnameworkspace).
# ::: :::
- - `permissions`
- Sequence
- The permissions for deploying and running the bundle in the target. See [\_](#targetsnamepermissions).
- - `presets`
- Map
- The deployment presets for the target. See [\_](#targetsnamepresets).
- - `resources`
- Map
- The resource definitions for the target. See [\_](#targetsnameresources).
- - `run_as`
- Map
- The identity to use to run the bundle, see [\_](/dev-tools/bundles/run-as.md). See [\_](#targetsnamerun_as).
- - `sync`
- Map
- The local paths to sync to the target workspace when a bundle is run or deployed. See [\_](#targetsnamesync).
- - `variables`
- Map
- The custom variable definitions for the target. See [\_](#targetsnamevariables).
- - `workspace` - Map - The Databricks workspace for the target. See [\_](#targetsnameworkspace).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
### targets.\<name\>.artifacts ### targets.\<name\>.artifacts
@ -639,6 +612,7 @@ artifacts:
<artifact-field-name>: <artifact-field-value> <artifact-field-name>: <artifact-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
@ -653,13 +627,9 @@ artifacts:
- String - String
- The executable type. Valid values are `bash`, `sh`, and `cmd`. - The executable type. Valid values are `bash`, `sh`, and `cmd`.
<<<<<<< HEAD
- - `files` - - `files`
- Sequence - Sequence
- # The source files for the artifact. See [\_](#targetsnameartifactsnamefiles). - The source files for the artifact. See [_](#targetsnameartifactsnamefiles).
* - `files` - Sequence - The source files for the artifact. See [\_](#targetsnameartifactsnamefiles).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `path` - - `path`
- String - String
@ -671,12 +641,15 @@ artifacts:
::: :::
### targets.\<name\>.artifacts.\<name\>.files ### targets.\<name\>.artifacts.\<name\>.files
**`Type: Sequence`** **`Type: Sequence`**
The source files for the artifact. The source files for the artifact.
:::list-table :::list-table
- - Key - - Key
@ -689,12 +662,15 @@ The source files for the artifact.
::: :::
### targets.\<name\>.bundle ### targets.\<name\>.bundle
**`Type: Map`** **`Type: Map`**
The bundle attributes when deploying to this target. The bundle attributes when deploying to this target.
:::list-table :::list-table
- - Key - - Key
@ -703,7 +679,7 @@ The bundle attributes when deploying to this target.
- - `cluster_id` - - `cluster_id`
- String - String
- The ID of a cluster to use to run the bundle. See [\_](/dev-tools/bundles/settings.md#cluster_id). - The ID of a cluster to use to run the bundle. See [_](/dev-tools/bundles/settings.md#cluster_id).
- - `compute_id` - - `compute_id`
- String - String
@ -711,25 +687,15 @@ The bundle attributes when deploying to this target.
- - `databricks_cli_version` - - `databricks_cli_version`
- String - String
- The Databricks CLI version to use for the bundle. See [\_](/dev-tools/bundles/settings.md#databricks_cli_version). - The Databricks CLI version to use for the bundle. See [_](/dev-tools/bundles/settings.md#databricks_cli_version).
<<<<<<< HEAD
- - `deployment` - - `deployment`
- Map - Map
- The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). See [\_](#targetsnamebundledeployment). - The definition of the bundle deployment. For supported attributes see [_](/dev-tools/bundles/deployment-modes.md). See [_](#targetsnamebundledeployment).
- - `git` - - `git`
- Map - Map
- # The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). See [\_](#targetsnamebundlegit). - The Git version control details that are associated with your bundle. For supported attributes see [_](/dev-tools/bundles/settings.md#git). See [_](#targetsnamebundlegit).
* - `deployment`
- Map
- The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). See [\_](#targetsnamebundledeployment).
* - `git` - Map - The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). See [\_](#targetsnamebundlegit).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `name` - - `name`
- String - String
@ -741,11 +707,14 @@ The bundle attributes when deploying to this target.
::: :::
### targets.\<name\>.bundle.deployment ### targets.\<name\>.bundle.deployment
**`Type: Map`** **`Type: Map`**
The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md). The definition of the bundle deployment. For supported attributes see [_](/dev-tools/bundles/deployment-modes.md).
:::list-table :::list-table
@ -757,16 +726,12 @@ The definition of the bundle deployment. For supported attributes see [\_](/dev-
- Boolean - Boolean
- Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted. - Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.
<<<<<<< HEAD
- - `lock` - - `lock`
- Map - Map
- The deployment lock attributes. See [\_](#targetsnamebundledeploymentlock). - The deployment lock attributes. See [_](#targetsnamebundledeploymentlock).
# ::: :::
- - `lock` - Map - The deployment lock attributes. See [\_](#targetsnamebundledeploymentlock).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
### targets.\<name\>.bundle.deployment.lock ### targets.\<name\>.bundle.deployment.lock
@ -774,6 +739,8 @@ The definition of the bundle deployment. For supported attributes see [\_](/dev-
The deployment lock attributes. The deployment lock attributes.
:::list-table :::list-table
- - Key - - Key
@ -790,11 +757,14 @@ The deployment lock attributes.
::: :::
### targets.\<name\>.bundle.git ### targets.\<name\>.bundle.git
**`Type: Map`** **`Type: Map`**
The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git). The Git version control details that are associated with your bundle. For supported attributes see [_](/dev-tools/bundles/settings.md#git).
:::list-table :::list-table
@ -804,20 +774,23 @@ The Git version control details that are associated with your bundle. For suppor
- - `branch` - - `branch`
- String - String
- The Git branch name. See [\_](/dev-tools/bundles/settings.md#git). - The Git branch name. See [_](/dev-tools/bundles/settings.md#git).
- - `origin_url` - - `origin_url`
- String - String
- The origin URL of the repository. See [\_](/dev-tools/bundles/settings.md#git). - The origin URL of the repository. See [_](/dev-tools/bundles/settings.md#git).
::: :::
### targets.\<name\>.git ### targets.\<name\>.git
**`Type: Map`** **`Type: Map`**
The Git version control settings for the target. The Git version control settings for the target.
:::list-table :::list-table
- - Key - - Key
@ -826,20 +799,23 @@ The Git version control settings for the target.
- - `branch` - - `branch`
- String - String
- The Git branch name. See [\_](/dev-tools/bundles/settings.md#git). - The Git branch name. See [_](/dev-tools/bundles/settings.md#git).
- - `origin_url` - - `origin_url`
- String - String
- The origin URL of the repository. See [\_](/dev-tools/bundles/settings.md#git). - The origin URL of the repository. See [_](/dev-tools/bundles/settings.md#git).
::: :::
### targets.\<name\>.permissions ### targets.\<name\>.permissions
**`Type: Sequence`** **`Type: Sequence`**
The permissions for deploying and running the bundle in the target. The permissions for deploying and running the bundle in the target.
:::list-table :::list-table
- - Key - - Key
@ -864,12 +840,15 @@ The permissions for deploying and running the bundle in the target.
::: :::
### targets.\<name\>.presets ### targets.\<name\>.presets
**`Type: Map`** **`Type: Map`**
The deployment presets for the target. The deployment presets for the target.
:::list-table :::list-table
- - Key - - Key
@ -902,12 +881,15 @@ The deployment presets for the target.
::: :::
### targets.\<name\>.resources ### targets.\<name\>.resources
**`Type: Map`** **`Type: Map`**
The resource definitions for the target. The resource definitions for the target.
:::list-table :::list-table
- - Key - - Key
@ -920,55 +902,58 @@ The resource definitions for the target.
- - `clusters` - - `clusters`
- Map - Map
- The cluster definitions for the bundle, where each key is the name of a cluster. See [\_](/dev-tools/bundles/resources.md#clusters) - The cluster definitions for the bundle, where each key is the name of a cluster. See [_](/dev-tools/bundles/resources.md#clusters)
- - `dashboards` - - `dashboards`
- Map - Map
- The dashboard definitions for the bundle, where each key is the name of the dashboard. See [\_](/dev-tools/bundles/resources.md#dashboards) - The dashboard definitions for the bundle, where each key is the name of the dashboard. See [_](/dev-tools/bundles/resources.md#dashboards)
- - `experiments` - - `experiments`
- Map - Map
- The experiment definitions for the bundle, where each key is the name of the experiment. See [\_](/dev-tools/bundles/resources.md#experiments) - The experiment definitions for the bundle, where each key is the name of the experiment. See [_](/dev-tools/bundles/resources.md#experiments)
- - `jobs` - - `jobs`
- Map - Map
- The job definitions for the bundle, where each key is the name of the job. See [\_](/dev-tools/bundles/resources.md#jobs) - The job definitions for the bundle, where each key is the name of the job. See [_](/dev-tools/bundles/resources.md#jobs)
- - `model_serving_endpoints` - - `model_serving_endpoints`
- Map - Map
- The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [\_](/dev-tools/bundles/resources.md#model_serving_endpoints) - The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [_](/dev-tools/bundles/resources.md#model_serving_endpoints)
- - `models` - - `models`
- Map - Map
- The model definitions for the bundle, where each key is the name of the model. See [\_](/dev-tools/bundles/resources.md#models) - The model definitions for the bundle, where each key is the name of the model. See [_](/dev-tools/bundles/resources.md#models)
- - `pipelines` - - `pipelines`
- Map - Map
- The pipeline definitions for the bundle, where each key is the name of the pipeline. See [\_](/dev-tools/bundles/resources.md#pipelines) - The pipeline definitions for the bundle, where each key is the name of the pipeline. See [_](/dev-tools/bundles/resources.md#pipelines)
- - `quality_monitors` - - `quality_monitors`
- Map - Map
- The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [\_](/dev-tools/bundles/resources.md#quality_monitors) - The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [_](/dev-tools/bundles/resources.md#quality_monitors)
- - `registered_models` - - `registered_models`
- Map - Map
- The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [\_](/dev-tools/bundles/resources.md#registered_models) - The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [_](/dev-tools/bundles/resources.md#registered_models)
- - `schemas` - - `schemas`
- Map - Map
- The schema definitions for the bundle, where each key is the name of the schema. See [\_](/dev-tools/bundles/resources.md#schemas) - The schema definitions for the bundle, where each key is the name of the schema. See [_](/dev-tools/bundles/resources.md#schemas)
- - `volumes` - - `volumes`
- Map - Map
- The volume definitions for the bundle, where each key is the name of the volume. See [\_](/dev-tools/bundles/resources.md#volumes) - The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volumes)
::: :::
### targets.\<name\>.run_as ### targets.\<name\>.run_as
**`Type: Map`** **`Type: Map`**
The identity to use to run the bundle, see [\_](/dev-tools/bundles/run-as.md). The identity to use to run the bundle, see [_](/dev-tools/bundles/run-as.md).
:::list-table :::list-table
@ -986,12 +971,15 @@ The identity to use to run the bundle, see [\_](/dev-tools/bundles/run-as.md).
::: :::
### targets.\<name\>.sync ### targets.\<name\>.sync
**`Type: Map`** **`Type: Map`**
The local paths to sync to the target workspace when a bundle is run or deployed. The local paths to sync to the target workspace when a bundle is run or deployed.
:::list-table :::list-table
- - Key - - Key
@ -1012,6 +1000,7 @@ The local paths to sync to the target workspace when a bundle is run or deployed
::: :::
### targets.\<name\>.variables ### targets.\<name\>.variables
**`Type: Map`** **`Type: Map`**
@ -1024,6 +1013,7 @@ variables:
<variable-field-name>: <variable-field-value> <variable-field-name>: <variable-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
@ -1038,13 +1028,9 @@ variables:
- String - String
- The description of the variable. - The description of the variable.
<<<<<<< HEAD
- - `lookup` - - `lookup`
- Map - Map
- # The name of the alert, cluster*policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. See [*](#targetsnamevariablesnamelookup). - The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. See [_](#targetsnamevariablesnamelookup).
* - `lookup` - Map - The name of the alert, cluster*policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. See [*](#targetsnamevariablesnamelookup).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `type` - - `type`
- String - String
@ -1052,12 +1038,15 @@ variables:
::: :::
### targets.\<name\>.variables.\<name\>.lookup ### targets.\<name\>.variables.\<name\>.lookup
**`Type: Map`** **`Type: Map`**
The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.
:::list-table :::list-table
- - Key - - Key
@ -1114,12 +1103,15 @@ The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, m
::: :::
### targets.\<name\>.workspace ### targets.\<name\>.workspace
**`Type: Map`** **`Type: Map`**
The Databricks workspace for the target. The Databricks workspace for the target.
:::list-table :::list-table
- - Key - - Key
@ -1192,11 +1184,12 @@ The Databricks workspace for the target.
::: :::
## variables ## variables
**`Type: Map`** **`Type: Map`**
Defines a custom variable for the bundle. See [\_](/dev-tools/bundles/settings.md#variables). Defines a custom variable for the bundle. See [_](/dev-tools/bundles/settings.md#variables).
```yaml ```yaml
variables: variables:
@ -1204,6 +1197,7 @@ variables:
<variable-field-name>: <variable-field-value> <variable-field-name>: <variable-field-value>
``` ```
:::list-table :::list-table
- - Key - - Key
@ -1218,13 +1212,9 @@ variables:
- String - String
- The description of the variable - The description of the variable
<<<<<<< HEAD
- - `lookup` - - `lookup`
- Map - Map
- # The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID. See [\_](#variablesnamelookup). - The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID. See [_](#variablesnamelookup).
* - `lookup` - Map - The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID. See [\_](#variablesnamelookup).
> > > > > > > 4881fd873b6b615c79e5e792cdf62aac86d49642
- - `type` - - `type`
- String - String
@ -1232,12 +1222,15 @@ variables:
::: :::
### variables.\<name\>.lookup ### variables.\<name\>.lookup
**`Type: Map`** **`Type: Map`**
The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID. The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID.
:::list-table :::list-table
- - Key - - Key
@ -1294,11 +1287,14 @@ The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_poo
::: :::
## workspace ## workspace
**`Type: Map`** **`Type: Map`**
Defines the Databricks workspace for the bundle. See [\_](/dev-tools/bundles/settings.md#workspace). Defines the Databricks workspace for the bundle. See [_](/dev-tools/bundles/settings.md#workspace).
:::list-table :::list-table
@ -1371,3 +1367,4 @@ Defines the Databricks workspace for the bundle. See [\_](/dev-tools/bundles/set
- The workspace state path - The workspace state path
::: :::

1859
bundle/docsgen/output/resources.md
View File

File diff suppressed because it is too large Load Diff