databricks-cli/bundle/docsgen/templates/resources.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

76 lines
2.9 KiB
Markdown
Raw Normal View History

---
2025-01-28 10:16:38 +00:00
description: 'Learn about resources supported by Databricks Asset Bundles and how to configure them.'
---
2025-01-28 10:16:38 +00:00
<!-- DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli -->
# :re[DABS] resources
2025-01-28 10:16:38 +00:00
:re[DABS] allows you to specify information about the :re[Databricks] resources used by the bundle in the `resources` mapping in the bundle configuration. See [resources mapping](settings.md#resources) and [resources key reference](reference.md#resources).
2025-01-28 10:16:38 +00:00
This article outlines supported resource types for bundles and provides details and an example for each supported type. For additional examples, see [\_](resource-examples.md).
2025-01-28 10:16:38 +00:00
## <a id="resource-types"></a>Supported resources
The following table lists supported resource types for bundles. Some resources can be created by defining them in a bundle and deploying the bundle, and some resources only support referencing an existing resource to include in the bundle.
2025-01-28 10:16:38 +00:00
Resources are defined using the corresponding [Databricks REST API](https://docs.databricks.com/api/workspace/introduction) objects create operation request payload, where the objects supported fields, expressed as YAML, are the resources supported properties. Links to documentation for each resources corresponding payloads are listed in the table.
:::tip
The `databricks bundle validate` command returns warnings if unknown resource properties are found in bundle configuration files.
2025-01-28 10:16:38 +00:00
:::
2025-01-28 10:16:38 +00:00
:::list-table
2025-01-28 10:16:38 +00:00
- - Resource
- Create support
- Corresponding REST API object
2025-01-28 10:16:38 +00:00
- - [cluster](#clusters)
-
- [Cluster object](https://docs.databricks.com/api/workspace/clusters/create)
2025-01-28 10:16:38 +00:00
- - [dashboard](#dashboards)
-
- [Dashboard object](https://docs.databricks.com/api/workspace/lakeview/create)
2025-01-28 10:16:38 +00:00
- - [experiment](#experiments)
-
- [Experiment object](https://docs.databricks.com/api/workspace/experiments/createexperiment)
2025-01-28 10:16:38 +00:00
- - [job](#jobs)
-
- [Job object](https://docs.databricks.com/api/workspace/jobs/create)
2025-01-28 10:16:38 +00:00
- - [model (legacy)](#models)
-
- [Model (legacy) object](https://docs.databricks.com/api/workspace/modelregistry/createmodel)
2025-01-28 10:16:38 +00:00
- - [model_serving_endpoint](#model_serving_endpoints)
-
- [Model serving endpoint object](https://docs.databricks.com/api/workspace/servingendpoints/create)
2025-01-28 10:16:38 +00:00
- - [pipeline](#pipelines)
-
- [Pipeline object](https://docs.databricks.com/api/workspace/pipelines/create)
2025-01-28 10:16:38 +00:00
- - [quality_monitor](#quality_monitors)
-
- [Quality monitor object](https://docs.databricks.com/api/workspace/qualitymonitors/create)
2025-01-28 10:16:38 +00:00
- - [registered_model](#registered_models) (Unity Catalog)
-
- [Registered model object](https://docs.databricks.com/api/workspace/registeredmodels/create)
2025-01-28 10:16:38 +00:00
- - [schema](#schemas) (Unity Catalog)
-
- [Schema object](https://docs.databricks.com/api/workspace/schemas/create)
2025-01-28 10:16:38 +00:00
- - [volume](#volumes) (Unity Catalog)
-
- [Volume object](https://docs.databricks.com/api/workspace/volumes/create)
2025-01-28 10:16:38 +00:00
:::