組態參考
本文提供 Databricks 資產組合組態 （YAML） 所支援的密鑰參考。 請參閱 什麼是 Databricks 資產套件組合？。
如需完整的套件組合範例，請參閱 套件組合組態範例 和 套件組合範例 GitHub 存放庫。
文物
定義建置成果物的設定。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
build |
字串 | 在部署之前，可在本地執行的一組可選的建置命令。 |
executable |
字串 | 可執行檔類型。 有效值為 bash、sh和 cmd。 |
files |
地圖 | 建置成品檔案的相對或絕對路徑，定義為 artifact_file。 |
path |
字串 | 工件目錄的本機路徑。 |
type |
字串 | 如果成品是 Python 輪子，則為必要的。 成品的類型。 有效值為 whl 與 jar。 |
文物
定義建置成品的屬性，其中每個索引鍵都是成品的名稱，而值是 Map，定義 成品組建設定。 如需 artifacts 對應的相關信息，請參閱 文檔。
在 targets 對應中，您可以覆寫定義於套件配置頂層的工件設定。 請參閱 於 Databricks 資產套件中定義工件設定。
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
例
artifacts:
default:
type: whl
build: poetry build
path: .
工件文件
定義套件組合中的工件檔案。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
source |
字串 | 必填。 成品來源檔案。 |
捆 / 套裝
套件的屬性。 請參閱 套件組合。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
cluster_id |
字串 | 用來執行套件組合的叢集標識碼。 請參閱 cluster_id。 |
databricks_cli_version |
字串 | 要用於套件的 Databricks CLI 版本。 請參閱 databricks_cli_version。 |
deployment |
地圖 | 套件組合部署的定義。 如需支援的屬性，請參閱 部署 和 Databricks Asset Bundle 部署模式。 |
git |
地圖 | 與您的套件組合相關聯的 Git 版本控制詳細數據。 如需支援的屬性，請參閱 git 和 git。 |
name |
字串 | 必填。 套件組合的名稱。 |
uuid |
字串 | 保留。 套件組合的通用唯一標識碼 （UUID），可唯一識別內部 Databricks 系統中的套件組合。 這是在使用 Databricks 範本初始化套件組合項目時產生的（使用 databricks bundle init 命令）。 |
部署
定義套件部署屬性。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
fail_on_active_runs |
布爾 | 是否在運行中失敗。 如果設定為 true 執行中的部署可能會中斷。 |
lock |
地圖 | 部署鎖的屬性。 請參閱 鎖定。 |
實驗的
定義實驗性功能的屬性。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
python_wheel_wrapper |
布爾 | 是否要使用 Python 滾輪包裝函式。 |
scripts |
指令 （字串） | 要執行的命令 |
use_legacy_run_as |
布林代數 | 是否要使用舊有的「run_as」行為。 |
git
定義與套件組合相關聯的 Git 版本控制詳細數據。 請參閱 git 。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
origin_url |
字串 | 存放庫的原始URL。 請參閱 git 。 |
branch |
字串 | Git 分支名稱。 請參閱 git 。 |
授予
定義 Unity Catalog 物件的存取權。 如需詳細資訊，請參閱 使用 Unity 目錄連線到雲端物件記憶體和服務。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
principal |
字串 | 必填。 被授予許可權的主體名稱。 |
privileges |
字串 | 必填。 授與指定實體的許可權。 |
例
下列範例會使用授權來定義 Unity Catalog schema：
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 |
字串 | 在 level中擁有權限集的群組名稱。 |
level |
字串 | 必填。 針對此許可權所定義的使用者、群組、服務主體所允許的許可權。 |
service_principal_name |
字串 | 在 level中具有許可權集的服務主體名稱。 |
user_name |
字串 | 在 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 |
整數 | 作業的並行執行上限。 |
name_prefix |
字串 | 套件組合作業執行的前置詞。 |
pipelines_development |
布爾 | 管線部署是否應該鎖定在開發模式中。 |
source_linked_deployment |
布爾 | 是否要將部署連結至套件來源。 |
tags |
地圖 | 套件部署的標籤。 |
trigger_pause_status |
字串 | 要套用至所有作業觸發程式和排程的暫停狀態。 有效值為 PAUSED 或 UNPAUSED。 |
資源
用於定義套件內資源的映射，其中每個鍵代表資源的名稱，值則是一個用於定義該資源的映射。 如需 Databricks 資產套件組合支援資源和資源定義參考的詳細資訊，請參閱 Databricks 資產配套資源。
resources:
<resource-type>s:
<resource-name>:
<resource-field-name>: <resource-field-value>
| 鑰匙 | 類型 | 描述 |
|---|---|---|
clusters |
地圖 | 套件組合的叢集定義，其中每個索引鍵都是叢集的名稱。 請參閱叢集 |
dashboards |
地圖 | 套件組合的儀錶板定義，其中每個鍵值都是儀錶板的名稱。 請參閱儀錶板 |
experiments |
地圖 | 套件的實驗定義，其中每個鍵值都是實驗的名稱。 請參閱 實驗 |
jobs |
地圖 | 套件組合的作業定義，其中每個鍵都是作業的名稱。 請參閱 作業 |
model_serving_endpoints |
地圖 | 套件的模型服務端點定義，其中每個密鑰都是模型服務端點的名稱。 請參閱 model_serving_endpoint |
models |
地圖 | 套件組合的模型的定義，其中每個鍵值都是模型的名稱。 請參閱 模型（舊版） |
pipelines |
地圖 | 套件的管道定義，其中每個鍵都是管道的名稱。 請參閱 管線 |
quality_monitors |
地圖 | 套件組合的品質監控定義，其中每個鍵值都是品質監控的名稱。 請參閱 quality_monitor （Unity Catalog） |
registered_models |
地圖 | 套件組合的已註冊模型定義，其中每個索引鍵都是 Unity 目錄註冊模型的名稱。 請參閱 registered_model（Unity Catalog） |
schemas |
地圖 | 套件組合的架構定義，其中每個索引鍵都是架構的名稱。 請參閱 架構 （Unity 目錄） |
volumes |
地圖 | 套件組合的磁碟區定義，其中每個索引鍵都是磁碟區的名稱。 請參閱 卷（Unity Catalog） |
run_as
執行 Databricks Asset Bundles 工作流程時要使用的身分識別。 請參閱 為 Databricks 資產套件工作流程指定作業識別。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
service_principal_name |
字串 | 使用中服務主體的應用程式識別碼。 設定此欄位需要 servicePrincipal/user 角色。 |
user_name |
字串 | 工作區使用者的電子郵件。 非系統管理員使用者只能將此字段設定為自己的電子郵件。 |
同步
要在套件組合中包含或排除的檔案和檔案路徑。 請參考 同步。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
exclude |
序列 | 要從套件組合中排除的檔案或資料夾清單。 |
include |
序列 | 要包含在套件組合中的檔案或資料夾清單。 |
paths |
序列 | 本機資料夾的路徑，可以位於套件根目錄之外，當套件部署時將同步至工作區。 |
目標
定義套件組合的部署目標。 請參閱 目標
| 鑰匙 | 類型 | 描述 |
|---|---|---|
artifacts |
地圖 | 要包含在目標部署中的構件。 請參閱 成品。 |
bundle |
地圖 | 部署到此目標時的組合屬性。 |
cluster_id |
字串 | 要用於此目標的叢集標識碼。 |
compute_id |
字串 | 已停用的。 要用於此目標的計算識別碼。 |
default |
布爾 | 此目標是否為預設目標。 |
git |
地圖 | 目標的 Git 版本控制設定。 請參閱 git 。 |
mode |
字串 | 目標的部署模式。 有效值為 development 或 production。 請參閱 Databricks Asset Bundle 部署模式。 |
permissions |
序列 | 在目標中部署和執行套件組合的許可權。 請參閱 許可權。 |
presets |
地圖 | 目標的預設部署設定。 請參閱 預設值。 |
resources |
地圖 | 目標的資源定義。 請參閱 資源。 |
run_as |
地圖 | 用來執行套件的身份。 請參閱 run_as 並在 指定 Databricks 資產包工作流程的執行身份。 |
sync |
地圖 | 套件組合運行或部署時，同步到目標工作區的本地路徑。 請參閱 同步 |
variables |
地圖 | 目標的自定義變數定義。 請參閱 Databricks Asset Bundles 中的 變數 和替代和變數。 |
workspace |
地圖 | 目標的 Databricks 工作區。 工作區 |
變數
定義套件中自定義變數的映射，其中每個鍵是變數的名稱，值則是一個映射，定義了該變數。 請參閱 Databricks Asset Bundles 中的替代和變數。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
| 變數名稱 | 地圖 | 變數的定義。 請參閱 變數名稱。 |
變數名稱
每個變數定義都有下列屬性：
| 鑰匙 | 類型 | 描述 |
|---|---|---|
description |
字串 | 變數的描述。 |
lookup |
字串 | 要為其擷取標識碼的 alert、cluster_policy、cluster、dashboard、instance_pool、job、metastore、pipeline、query、service_principal或 warehouse 對象的名稱。 |
type |
字串 | 變數的類型。 合法值為 complex。 |
工作空間
定義套件組合的 Databricks 工作區。 請參閱 工作區。
| 鑰匙 | 類型 | 描述 |
|---|---|---|
artifact_path |
字串 | 工作區內用於部署和工作流程運行的工件路徑 |
auth_type |
字串 | 驗證類型。 |
azure_client_id |
字串 | Azure 用戶端標識碼。 |
azure_environment |
字串 | Azure 環境。 |
azure_login_app_id |
字串 | Azure 登入應用程式識別碼。 |
azure_tenant_id |
字串 | Azure 租用戶 ID。 |
azure_use_msi |
布爾 | 是否要針對 Azure 使用 MSI。 |
azure_workspace_resource_id |
字串 | Azure 工作區資源標識碼。 |
client_id |
字串 | 工作區的用戶端識別碼。 |
file_path |
字串 | 在工作區內用於部署和工作流程執行的檔案路徑。 |
google_service_account |
字串 | Google 服務帳戶名稱。 |
host |
字串 | Databricks 工作區主機 URL。 |
profile |
字串 | Databricks 工作區配置檔名稱。 |
resource_path |
字串 | 工作區資源路徑。 |
root_path |
字串 | Databricks 工作區根路徑。 |
state_path |
字串 | 工作區狀態路徑。 |