Konfigurációs referencia

Ez a lap a Deklaratív Automation-csomagok (korábbi nevén Databricks Asset Bundles) konfigurációja (YAML) által támogatott kulcsokra nyújt referenciát. Lásd : Mik azok a deklaratív automatizálási csomagok?.

A csomagra vonatkozó teljes példákért lásd Csomagkonfigurációs példákat és a csomagpéldák GitHub-adattárát.

Műtárgyak

Type: Map

Megadja azokat az összetevőket, amelyeket automatikusan létre kell készíteni a csomagtelepítések során, amelyek később használhatók a csomagfuttatásokban. Minden kulcs az összetevő neve, az érték pedig egy térkép, amely meghatározza az összetevő buildbeállításait.

Jótanács

A csomagokban lévő összetevők beállításait a Célbeállítások felülbírálása című cikkben leírtak szerint definiálhatja, kombinálhatja és felülbírálhatja.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Kulcs Típus Leírás
build Szál Az üzembe helyezés előtt helyileg futtatandó buildparancsok választható készlete. A Python-kerekes buildek esetében a Databricks CLI feltételezi, hogy megtalálja a Python-csomag wheel helyi telepítését a buildek futtatásához, és alapértelmezés szerint futtatja a parancsot python setup.py bdist_wheel az egyes csomagtelepítések során. Adjon meg több buildparancsot külön sorokban.
dynamic_version logikai Dinamikusan javítsuk-e a wheel verziót a whl fájl időbélyege alapján. Ha ez a beállítás aktiválva van true, az új kód üzembe helyezhető anélkül, hogy frissíteni kellene a verziót a setup.py vagy pyproject.toml esetén. Ez a beállítás csak akkor érvényes, ha type be van állítva.whl
Hozzáadva a Databricks CLI 0.245.0-s verziójához
executable Szál A végrehajtható típus. Az érvényes értékek a következők: bash, shés cmd.
files Következés A beépített összetevőfájlok relatív vagy abszolút elérési útja. Tekintse meg az artefaktumokat.name.files.
path Szál Az artefaktum könyvtárának helyi elérési útja. Az elérési utak a csomagkonfigurációs fájl helyéhez viszonyítva vannak. A Python-kerekes buildek esetében ez a Python-kerékfájl fájljának setup.py elérési útja. Ha path nem szerepel a fájlban, a Databricks parancssori felület megpróbálja megtalálni a Python-kerekes fájl fájlját setup.py a csomag gyökérkönyvtárában.
type Szál Kötelező, ha az összetevő Python-kerék. Az artefaktum típusa. Az érvényes értékek whl és jar. Ezt a beállítást nem kell megadni más összetevők létrehozásához.

Példák

Az alábbi konfiguráció egy Python-kereket hoz létre a Poetry használatával:

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

Az alábbi konfiguráció teszteket futtat, és egy kereket hoz létre. A kerekek összeállításához használt artifacts teljes csomagokkal kapcsolatos oktatóanyagért tekintse meg a Python-kerékfájl deklaratív automation-csomagok használatával történő összeállítását ismertető témakört.

artifacts:
  default:
    type: whl
    build: |-
      # run tests
      python -m pytest tests/ -v

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

Egy példakonfigurációt, amely JAR-t készít és a Unity Catalogba feltölti, lásd itt: A JAR-fájlt Unity Catalogba feltöltő csomag.

Leletek. name.files

Type: Sequence

A beépített összetevőfájlok relatív vagy abszolút elérési útja. A beépített összetevők megadására használható source . Az elérési utak a csomagkonfigurációs fájl helyéhez viszonyítva vannak.

Kulcs Típus Leírás
source Szál Szükséges. Az összetevő forrásfájlja.

csomag

Type: Map

A csomagattribútumok a célra való telepítéskor.

A csomagkonfigurációs fájlnak csak egy legfelső szintű bundle leképezést kell tartalmaznia.

Ennek a bundle leképezésnek tartalmaznia kell egy leképezést name , amely a köteg programozott (vagy logikai) nevét adja meg. Az alábbi példa egy programozott (vagy logikai) névvel hello-bundlerendelkező csomagot deklarál.

bundle:
  name: hello-bundle

A bundle leképezés a legfelső szintű célok leképezésében szereplő egy vagy több cél gyermekének is lehet. Ezek a gyermekleképezések bundle meghatároznak minden nem alapértelmezett felülbírálást a cél szintjén.

Kulcs Típus Leírás
cluster_id Szál A csomag futtatásához használandó klaszter azonosítója. Ez a kulcs lehetővé teszi egy fürt azonosítójának megadását felülbírálásként a csomagkonfigurációs fájlban máshol definiált fürtök esetében. A fürt azonosítójának lekéréséről további információt a számítási erőforrás URL-címéről és azonosítójáról talál.
A cluster_id felülbírálás kizárólag fejlesztési célokra készült, és csak annak a célnak az esetében támogatott, amelynél a mode leképezést development-re állították be. A leképezésről további információt a targetcélokat ismertető cikkben talál.
compute_id Szál Elavult. A csomag futtatásához használandó számítás azonosítója.
databricks_cli_version Szál A csomaghoz használandó Databricks CLI-verzió. Lásd : bundle.databricks_cli_version.
deployment Térkép A csomag üzembe helyezésének definíciója. A támogatott attribútumokért lásd a Deklaratív Automation-csomagok üzembehelyezési módjait. Lásd: bundle.deployment.
engine Szál A használni kívánt üzembehelyezési motor. Az érvényes értékek terraform és direct. Az alapértelmezett érték a direct. Ez a konfiguráció elsőbbséget élvez a DATABRICKS_BUNDLE_ENGINE környezeti változóval szemben. A közvetlen üzembehelyezési motorral kapcsolatos információkért lásd: Migrálás a közvetlen üzembehelyezési motorra.
Hozzáadva a Databricks CLI 0.295.0-s verziójához
git Térkép A Csomaghoz társított Git-verziókövetési adatok. A támogatott attribútumokért lásd a gitet.
name Szál A csomag neve.
uuid Szál Fenntartott. A csomag univerzálisan egyedi azonosítója (UUID), amely egyedileg azonosítja a csomagot a belső Databricks-rendszerekben. Ez akkor jön létre, ha egy csomagprojekt inicializálása Databricks-sablonnal történik (a databricks bundle init paranccsal).
Hozzáadva a Databricks CLI 0.236.0-s verziójához

bundle.databricks_cli_version

A bundle leképezés tartalmazhat olyan leképezést databricks_cli_version , amely korlátozza a csomag által igényelt Databricks CLI-verziót. Ez megakadályozhatja a Databricks parancssori felület egy bizonyos verziójában nem támogatott leképezések használatával kapcsolatos problémákat.

A Databricks CLI verziója megfelel a szemantikai verziószámozásnak , és a leképezés támogatja a databricks_cli_versionverziókorlátozások megadását. Ha az aktuális databricks --version érték nem a köteg databricks_cli_version leképezésében megadott korlátokon belül van, hiba történik, amikor a databricks bundle validate a kötegen végrehajtódik. Az alábbi példák néhány gyakori verziókorlátozási szintaxist mutatnak be:

bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.0' # require Databricks CLI 0.218.0

bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.*' # allow all patch versions of Databricks CLI 0.218

bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0' # allow any version of Databricks CLI 0.218.0 or higher

bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0, <= 1.0.0' # allow any Databricks CLI version between 0.218.0 and 1.0.0, inclusive

bundle.deployment

Type: Map

A csomag üzembe helyezésének definíciója

Kulcs Típus Leírás
fail_on_active_runs logikai Az aktív futtatások sikertelenségének lehetősége. Ha ez igaz értékre van állítva, a futó üzembe helyezés megszakítható.
lock Térkép A telepítési zárolás attribútumai. Lásd: bundle.deployment.lock.

bundle.deployment.lock

Type: Map

A telepítési zárolás attribútumai.

Kulcs Típus Leírás
enabled logikai Engedélyezve van-e a zárolás.
force logikai Meg kell-e kényszeríteni ezt a zárolási funkciót, ha engedélyezett.

kísérleti

Type: Map

A kísérleti funkciók attribútumait határozza meg.

Kulcs Típus Leírás
immutable_folder logikai Azt, hogy a csomagot egy rejtett, írásvédett mappába szeretné-e telepíteni, hogy az üzembe helyezett eszközöket ne módosíthassák a nem rendszergazdai felhasználók, és a futó feladatokat nem érintik a folyamatban lévő üzembe helyezések. Lásd : immutable_folder.
Hozzáadva a Databricks CLI verzió 1.6.0
python Térkép Elavult. Használja inkább a legfelső szintű Python-leképezést .
Hozzáadva a Databricks CLI 0.238.0-s verziójához
python_wheel_wrapper logikai A Python kerekes csomag használatának mérlegelése.
record_deployment_history logikai A csomag üzembehelyezési előzményeinek rögzítése.
scripts Térkép A futtatandó parancsok.
skip_artifact_cleanup logikai Meghatározza, hogy kihagyja-e a mappa törlését a .internal mappán belül workspace.artifact_path. Alapértelmezés szerint ez a mappa törlődik, mielőtt új buildösszetevőket (például Python-kerekeket) tölt fel az üzembe helyezés során. Úgy van beállítva, hogy true megőrizze a meglévő összetevőket az üzemelő példányok között.
Hozzáadva a Databricks CLI 0.254.0-s verziójához
skip_name_prefix_for_schema logikai Kihagyhatja-e a csomagban presets.name_prefix definiált Unity Catalog-sémák neveihez való (be- vagy kiszámított mode: development) előtag hozzáadását.
Hozzáadva a Databricks CLI 0.255.0-s verziójához
use_legacy_run_as logikai Azt mérlegeljük, használjuk-e az örökölt run_as viselkedést.

immutable_folder

Fontos

A funkció privát előzetes verzióban érhető el. A kipróbálásához lépjen kapcsolatba az Azure Databricks-partnerrel.

Megjegyzés:

Ehhez a funkcióhoz a közvetlen üzembehelyezési motor szükséges, és a munkaterület fájljai engedélyezve vannak.

Ha a csomag továbbra is Terraformot használ, először migrálja a közvetlen üzembehelyezési motorra. Lásd : Meglévő csomag migrálása.

Ha a beállítás azexperimental.immutable_folder, a true Deklaratív Automation-csomagok egy rejtett, írásvédett pillanatkép mappába kerülnek, amely a kód egy adott verziójára mutat. A feladatok a pillanatkép mappából származó jegyzetfüzetekre és más munkaterületfájlokra hivatkoznak, például:

/Workspace/Users/<asp-id>/.snapshots/<bundle-id>/<deployment-id>/files/src/notebook

Ha engedélyezve van a nem módosítható mappák, az üzembe helyezett eszközöket nem módosíthatják a nem rendszergazdai felhasználók, ezért az üzembe helyezett elemek valójában éles környezetben futnak. (A munkaterület rendszergazdái továbbra is szerkeszthetik a pillanatkép mappában lévő fájlokat.) Emellett a feladatok fájljai nem frissíthetők a feladat futtatása során, még akkor sem, ha az üzembe helyezés a futtatás során történik.

Az üzemelő példányok legfeljebb 10 MB és 1000 fájlt tartalmazhatnak.

tartalmaz

Type: Sequence

Megadja azoknak az elérési utaknak a listáját, amelyek konfigurációs fájlokat tartalmaznak a csomagban. Ezek az elérésiút-globok annak a csomagkonfigurációs fájlnak a helyéhez vannak viszonyítva, amelyben az elérési út globok meg vannak adva. databricks.ymlA tömbön kívül meg kell adnia a include csomagba belefoglalandó összes konfigurációs fájlt.

Jótanács

Ha más fájlokat szeretne belefoglalni vagy kizárni a csomagba, használja a belefoglalást és a kizárást.

Ez a include tömb csak legfelső szintű leképezésként jelenhet meg.

Az alábbi példakonfiguráció három konfigurációs fájlt tartalmaz. Ezek a fájlok ugyanabban a mappában találhatók, mint a csomagkonfigurációs fájl:

include:
  - 'bundle.artifacts.yml'
  - 'bundle.resources.yml'
  - 'bundle.targets.yml'

Az alábbi példakonfiguráció tartalmazza az összes fájlnevet tartalmazó fájlt, amely a következővel bundle kezdődik és végződik .yml. Ezek a fájlok ugyanabban a mappában találhatók, mint a csomagkonfigurációs fájl:

include:
  - 'bundle*.yml'

engedélyek

Type: Sequence

Meghatározza a kötegben meghatározott erőforrásokra alkalmazandó engedélyeket, ahol a sorozat minden eleme egy adott entitás engedélye. Lásd: Engedélyek beállítása az erőforrásokhoz a Deklaratív automatizálási csomagokban.

Az engedélyezett legfelső szintű engedélyszintek a következőkCAN_VIEW: és CAN_MANAGECAN_RUN.

Ha engedélyeket szeretne alkalmazni egy adott erőforrásra, tekintse meg az adott erőforrás engedélyeinek definiálása című témakört.

Kulcs Típus Leírás
group_name Szál A csoport neve adta meg az engedély szintjét.
level Szál Szükséges. A jelentkezési engedély szintje. Az engedélyezett szintek attól függnek, hogy a jogosultságok a csomag felső szintjén vagy egy adott erőforrásra vannak meghatározva, illetve az erőforrás típusától. Lásd: Engedélyek beállítása az erőforrásokhoz a Deklaratív automatizálási csomagokban.
service_principal_name Szál A szolgálati igazgató neve adta meg az engedély szintjét.
user_name Szál A felhasználó neve adta meg az engedély szintjét.

példa

Az alábbi példakonfiguráció egy felhasználó, csoport és szolgáltatásnév engedélyszintjeit határozza meg, amelyek a csomagban resources definiált összes erőforrásra vonatkoznak:

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

Előbeállítások

Type: Map

A csomag üzembehelyezési előbeállításait határozza meg. További információ: Egyéni beállítások.

Ha nincs megadva kivétel egy előre beállított beállításhoz, ha mindkettő modepresets be van állítva, az előre beállított beállítások felülbírálják az alapértelmezett mód viselkedését, és az egyes erőforrások beállításai felülbírálják az előre beállított beállításokat.

Preset Leírás
artifacts_dynamic_version Annak eldöntése, hogy az összetevők verziójának whl dinamikus frissítése megtörténjen-e az üzembe helyezés során. Az érvényes értékek true vagy false. Ha a legfelső szintű artifacts.dynamic_version konfigurációs beállítás meg van adva, felülbírálja ezt az előre beállított beállítást.
Hozzáadva a Databricks CLI 0.256.0-s verziójához
jobs_max_concurrent_runs A feladatokhoz engedélyezett maximális egyidejű futtatások száma.
name_prefix Az erőforrásnevekre való előtag-sztring.
pipelines_development Meghatározza, hogy a pipeline telepítések fejlesztési módban legyenek-e zárolva. Az érvényes értékek true vagy false.
source_linked_deployment Azt jelzi, hogy az üzembe helyezés során létrehozott erőforrások a munkaterület másolatai helyett a munkaterületen lévő forrásfájlokra mutatnak-e.
Hozzáadva a Databricks CLI 0.236.0-s verziójához
tags Kulcs:értékcímkék készlete, amelyek a címkéket támogató összes erőforrásra vonatkoznak, beleértve a feladatokat és kísérleteket is. A deklaratív Automation-csomagok nem támogatják az erőforrás címkéit schema .
trigger_pause_status Az összes eseményindítóra és ütemezésre alkalmazandó szüneteltetés állapota. Az érvényes értékek PAUSED vagy UNPAUSED.
Ha mode be van állítva development, trigger_pause_status mindig PAUSED.

piton

Type: Map

Konfigurálja a databricks-bundles csomaggal definiált Python-kód betöltését. További információ: Csomagkonfiguráció a Pythonban.

Át lett helyezve a Databricks CLI 0.275.0-s verziójából experimental

Kulcs Típus Leírás
mutators Következés A mutálók a mutációs függvények teljes mértékben minősített függvényútvonalainak listáját tartalmazzák, például [my_project.mutators:add_default_cluster].
Hozzáadva a Databricks CLI 0.238.0-s verziójához
resources Következés Az erőforrások a Python-kódban definiált erőforrások betöltéséhez szükséges, teljes mértékben minősített függvényútvonalak listáját tartalmazzák, például ["my_project.resources:load_resources"]
Hozzáadva a Databricks CLI 0.238.0-s verziójához
venv_path Szál A virtuális környezet elérési útja. Ha engedélyezve van, a Python-kód ezen a környezetben fut. Ha le van tiltva, alapértelmezés szerint az aktuális rendszerhéjban elérhető Python-értelmezőt használja.
Hozzáadva a Databricks CLI 0.238.0-s verziójához

Erőforrások

Type: Map

Meghatározza a köteg erőforrásait, ahol minden kulcs az erőforrás neve, az érték pedig egy térkép, amely meghatározza az erőforrást. A deklaratív automatizálási csomagok által támogatott erőforrásokról és az erőforrásdefiníciós referenciaról további információt a Deklaratív automation-csomagok erőforrásai című témakörben talál.

A resources megfeleltetés legfelső szintű leképezésként jelenhet meg, vagy a legfelső szintű célok leképezésének egy vagy több példányának gyermeke lehet, és nulla vagy egy támogatott erőforrástípust tartalmaz. Minden erőforrástípus-megfeleltetés egy vagy több egyedi erőforrás-deklarációt tartalmaz, amelyeknek egyedi névvel kell rendelkezniük. Ezek az egyéni erőforrás-deklarációk a megfelelő objektum létrehozási műveletének YAML-ben kifejezett kérés adatait használják az erőforrás meghatározásához. Az erőforrás támogatott tulajdonságai a megfelelő objektum által támogatott mezők.

A műveletkérelem payloadjai a Databricks REST API-referencia dokumentációjában szerepelnek, és a parancs az összes támogatott objektumsémát jeleníti meg. Ezenkívül a databricks bundle validate parancs figyelmeztetéseket ad vissza, ha ismeretlen erőforrás-tulajdonságok találhatók a csomagkonfigurációs fájlokban.

A csomagokban támogatott erőforrásokról, valamint a gyakori konfigurációkról és példákról további információt a Deklaratív Automation-csomagok erőforrásai és a Csomagkonfigurációs példák című témakörben talál.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Kulcs Típus Leírás
alerts Térkép A csomag riasztási (v2) definíciói, ahol minden kulcs az egyes riasztások nevét jelöli. Lásd riasztás.
Hozzáadva a Databricks CLI 0.279.0-s verziójához
apps Térkép A csomag Databricks-alkalmazásdefiníciói, ahol minden kulcs az alkalmazás neve. Lásd a(z) alkalmazást.
Hozzáadva a Databricks CLI 0.239.0-s verziójához
catalogs Térkép A csomag katalógusának (Unity Catalog) definíciói, ahol minden kulcs egy katalógus neve. Lásd a katalógusokat.
Hozzáadva a Databricks CLI 0.287.0-s verziójához
clusters Térkép A csomag fürtdefiníciói, ahol minden kulcs egy fürt neve. Lásd a klasztert.
dashboards Térkép A csomag irányítópult-definíciói, ahol minden kulcs az irányítópult neve. Lásd irányítópult.
Hozzáadva a Databricks CLI 0.232.0-s verziójához
database_catalogs Térkép A csomag adatbáziskatalógus-definíciói, ahol minden kulcs az adatbáziskatalógus neve. Lásd : database_catalog.
Hozzáadva a Databricks CLI 0.265.0-s verziójához
database_instances Térkép A csomag adatbázispéldány-definíciói, ahol minden kulcs az adatbázispéldány neve. Lásd : database_instance.
Hozzáadva a Databricks CLI 0.265.0-s verziójához
experiments Térkép A köteg kísérletdefiníciói, ahol minden kulcs a kísérlet neve. Lásd a kísérletet.
external_locations Térkép A csomag külső helydefiníciói, ahol minden kulcs a hely neve. Lásd : external_location (Unity Catalog).
Hozzáadva a Databricks CLI 0.289.0-s verziójához
genie_spaces Térkép A csomag Genie-ügynökdefiníciói, ahol minden kulcs a Genie-ügynök neve. Lásd : genie_space.
Hozzáadva a Databricks CLI 1.3.0-s verziójához
instance_pools Térkép A példány pool definíciói a csomagra, ahol minden kulcs a példány pool neve. Lásd instance_pool.
Hozzáadva a Databricks CLI 1.9.0-s verziójához
job_runs Térkép A munkafuttatás definíciói a csomaghoz, ahol minden kulcs a feladat futásának neve. Minden feladat futtatása egy meglévő feladat futtatását indítja el a bundle telepítés részeként. Lásd job_run.
Hozzáadva a Databricks CLI 1.7.0-s verziójához
jobs Térkép A csomag feladatdefiníciói, ahol minden kulcs a feladat neve. Lásd a feladatot.
model_serving_endpoints Térkép A csomag végpontdefinícióit kiszolgáló modell, ahol minden kulcs a végpontot kiszolgáló modell neve. Lásd model_serving_endpoint.
models Térkép A csomag modelldefiníciói, ahol minden kulcs a modell neve. Lásd : modell (örökölt).
pipelines Térkép A csomag folyamatdefiníciói, ahol minden kulcs a folyamat neve. Lásd a csővezetéket.
postgres_branches Térkép A csomag Postgres-ágdefiníciói, ahol minden kulcs a Lakebase-ág neve. Lásd : postgres_branch.
Hozzáadva a Databricks CLI 0.287.0-s verziójához
postgres_catalogs Térkép A csomag Postgres-katalógusdefiníciói, ahol minden kulcs a katalógus neve. Lásd : postgres_catalog.
Hozzáadva a Databricks CLI 1.0.0-s verziójához
postgres_databases Térkép A csomag Postgres-adatbázisdefiníciói, ahol minden kulcs az adatbázis neve. Lásd : postgres_database.
Hozzáadva a Databricks CLI 1.4.0-s verziójához
postgres_endpoints Térkép A csomag Postgres-végpontdefiníciói, ahol minden kulcs a Lakebase számítási végpontjának neve. Lásd : postgres_endpoint.
Hozzáadva a Databricks CLI 0.287.0-s verziójához
postgres_projects Térkép A csomag Postgres-projektdefiníciói, ahol minden kulcs a Lakebase-projekt neve. Lásd : postgres_project.
Hozzáadva a Databricks CLI 0.287.0-s verziójához
postgres_roles Térkép A csomag Postgres szerepkördefiníciói, ahol minden kulcs a szerepkör neve. Lásd : postgres_role.
Hozzáadva a Databricks CLI 1.4.0-s verziójához
postgres_synced_tables Térkép A Postgres szinkronizált tábladefiníciók a csomaghoz, ahol minden kulcs a szinkronizált tábla neve. Lásd : postgres_synced_table.
Hozzáadva a Databricks CLI 1.0.0-s verziójához
quality_monitors Térkép A csomag minőségi monitorozási definíciói, ahol minden kulcs a minőségfigyelő neve. Lásd : quality_monitor (Unity Catalog).
registered_models Térkép A csomag regisztrált modelldefiníciói, ahol minden kulcs a Unity Katalógusban regisztrált modell neve. Lásd registered_model (Unity Catalog).
schemas Térkép A csomag sémadefiníciói, ahol minden kulcs a séma neve. Lásd séma (Unity Catalog).
secret_scopes Térkép A csomag titkos hatókör-definíciói, ahol minden kulcs a titkos kulcs hatókörének neve. Lásd secret_scope.
Hozzáadva a Databricks CLI 0.252.0-s verziójához
sql_warehouses Térkép A csomag SQL Warehouse-definíciói, ahol minden kulcs az SQL Warehouse neve. Lásd : sql_warehouse.
Hozzáadva a Databricks CLI 0.260.0-s verziójához
synced_database_tables Térkép A csomag szinkronizált adatbázistábla-definíciói, ahol minden kulcs az adatbázistábla neve. Lásd synced_database_table.
Hozzáadva a Databricks CLI 0.266.0-s verziójához
vector_search_endpoints Térkép A csomag AI Search-végpontdefiníciói, ahol minden kulcs az AI Search-végpont neve. Lásd : vector_search_endpoint.
Hozzáadva a Databricks CLI 0.298.0-s verziójához
vector_search_indexes Térkép A csomag vektorkeresési indexének definíciói, ahol minden kulcs a vektorkeresési index neve. Lásd : vector_search_index.
Hozzáadva a Databricks CLI 1.1.0-s verziójához
volumes Térkép A kötetcsoport kötetmeghatározásai, ahol minden kulcs egy kötet neve. Lásd: kötet ("Unity Catalog").
Hozzáadva a Databricks CLI 0.236.0-s verziójához

példa

A következő példakonfiguráció egy feladaterőforrást határoz meg:

resources:
  jobs:
    hello-job:
      name: hello-job
      tasks:
        - task_key: hello-task
          existing_cluster_id: 1234-567890-abcde123
          notebook_task:
            notebook_path: ./hello.py

run_as

Type: Map

A Deklaratív Automation Bundles-erőforrások futtatásához használandó identitás (user_name vagy service_principal_name) Lehetővé teszi a csomagfeladat vagy folyamat üzembe helyezéséhez használt identitás elkülönítését a feladat vagy folyamat futtatásához használt identitástól. Lásd: Futtatási identitás megadása deklaratív automation-kötegek munkafolyamatához.

Kulcs Típus Leírás
service_principal_name Szál Egy aktív szolgáltatási főazonosító alkalmazásazonosítója. A mező beállításához servicePrincipal/user szerepkör szükséges.
user_name Szál Egy aktív munkaterület-felhasználó e-mail-címe. A nem rendszergazdai felhasználók ezt a mezőt csak saját e-mail-címükre állíthatják be.

Parancsfájlok

Type: Map

A bundle run segítségével futtatható szkriptek. Az scripts leképezésben lévő minden elnevezett szkript parancsokat tartalmazó tartalommal rendelkezik. Lásd: Szkriptek végrehajtása.

Hozzáadva a Databricks CLI 0.259.0-s verziójához

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Kulcs Típus Leírás
content Szál A futtatandó parancsok
Hozzáadva a Databricks CLI 0.259.0-s verziójához
env Térkép Környezeti változók térképe, amelyeket exportálni kell a szkript futtatásakor. Az értékek hivatkozhatnak ${bundle.*}, ${workspace.*}, és ${var.*} és a megoldódnak, mielőtt a szkript fut. Hivatkozz rájuk a content -ről $NAME.
Hozzáadva a Databricks CLI verzió 1.8.0

Példák

scripts:
  my_script:
    content: uv run pytest -m dev

Az alábbi példa a csomag célpontját és egy egyedi változót adja át a szkriptnek környezeti változóként:

scripts:
  deploy_report:
    env:
      TARGET: ${bundle.target}
      CATALOG: ${var.catalog}
    content: uv run python report.py --target "$TARGET" --catalog "$CATALOG"

szinkron

Type: Map

A csomagba felvenni vagy kizárni kívánt fájlok és fájlelérési utak.

Kulcs Típus Leírás
exclude Következés A csomagból kizárandó fájlok vagy mappák listája. Lásd: belefoglalás és kizárás.
include Következés A csomagba felvenni kívánt fájlok vagy mappák listája. Lásd: belefoglalás és kizárás.
paths Következés A helyi mappa elérési útjai, amelyek a csomag gyökérkönyvtárán kívül is lehetnek, szinkronizálandók a munkaterülettel, amikor a csomag üzembe van helyezve. Lásd: sync.paths.

belefoglalás és kizárás

A include leképezésen belüli exclude és sync leképezések az alábbi szabályoktól függően megszabják azoknak a fájloknak vagy mappáknak a listáját, amelyeket a csomagtelepítésekbe belefoglalnak vagy kizárnak:

  • A köteg gyökérkönyvtárában található .gitignore fájlok és elérési utak összes listája alapján a include leképezés a fájlgyökeréhez képest tartalmazhat fájlgyökereket, elérési utakat vagy mindkettőt a csomag gyökérkönyvtárához képest, hogy explicit módon szerepeljen bennük.
  • Az .gitignore fájlban található fájl- és elérésiút-globok listája a csomag gyökérkönyvtárában, valamint az include leképezésben található fájl- és elérésiút-globok listája alapján a exclude leképezés tartalmazhat fájl-globokat, elérésiút-globokat vagy mindkettőt, a csomag gyökérkönyvtárához képest, hogy explicit módon kizárja őket.

A megadott fájlok és mappák minden elérési útja annak a csomagkonfigurációs fájlnak a helyéhez képest van, amelyben meg vannak adva.

A include fájl- és elérésiút-minták szintaxisa a exclude mintaszintaxis szokásos szabályait követi. Lásd a gitignore mintaformátumát.

Ha például a következő .gitignore fájl a következő bejegyzéseket tartalmazza:

.databricks
my_package/dist

A csomagkonfigurációs fájl pedig a következő include leképezést tartalmazza:

sync:
  include:
    - my_package/dist/*.whl

Ezután a my_package/dist mappában lévő, *.whl fájlkiterjesztéssel rendelkező összes fájl bekerül. A my_package/dist mappában lévő többi fájl nem szerepel.

Ha azonban a csomagkonfigurációs fájl a következő exclude leképezést is tartalmazza:

sync:
  include:
    - my_package/dist/*.whl
  exclude:
    - my_package/dist/delete-me.whl

Ezután az my_package/dist mappában lévő összes fájl, amelynek fájlkiterjesztése *.whl, bekerül, kivéve a delete-me.whl nevű fájlt. A my_package/dist mappában lévő többi fájl sem tartozik bele.

A sync leképezés a targets leképezésben is deklarálható egy meghatározott cél esetén. A sync célban megadott leképezések minden legfelső szintű sync deklarációval egyesülnek. Az előző példával folytatva például a következő include leképezés a targets szinten egyesül a legfelső szintű includesync leképezéssel.

targets:
  dev:
    sync:
      include:
        - my_package/dist/delete-me.whl

Megjegyzés:

A include minták csak exclude a sync.paths mappában található fájlokat szűrik. Nem adhatnak hozzá fájlokat olyan mappából, amely nem fedi le a szinkronizálási útvonalat. Mivel paths alapértelmezés szerint a csomaggyökér (.), include és exclude a teljes csomaggyökérre vonatkozik, hacsak nem szűkíti a pathselemet.

sync.paths

A sync leképezés tartalmazhat olyan leképezést paths , amely meghatározza a munkaterületre szinkronizálandó helyi útvonalakat. A paths leképezés lehetővé teszi a gyakori fájlok kötegek közötti megosztását, és a csomaggyökeren kívül található fájlok szinkronizálására is használható. (A csomaggyökér a databricks.yml fájl helye.) Ez különösen akkor hasznos, ha egyetlen olyan adattárral rendelkezik, amely több csomagot üzemeltet, és tárakat, kódfájlokat vagy konfigurációkat szeretne megosztani.

A megadott elérési utaknak a paths-megfeleltetést tartalmazó mappában rögzített fájlokhoz és könyvtárakhoz kell viszonyítani. Ha egy vagy több elérési útérték a könyvtárakban a csomaggyökér elődjéhez halad, a gyökér elérési útja dinamikusan van meghatározva annak biztosítása érdekében, hogy a mappaszerkezet épségben maradjon. Ha például a csomag gyökérmappájának neve my_bundle, akkor ez a konfiguráció databricks.yml szinkronizálja a csomag gyökérmappáját, valamint az egy szinttel felette található common mappát.

sync:
  paths:
    - ../common
    - .

A csomag üzembe helyezése a következő mappastruktúrát eredményezi a munkaterületen:

common/
  common_file.txt
my_bundle/
  databricks.yml
  src/
    ...

Útvonalak kombinálása belefoglalással és kizárással

A pathsrendszer sorrendben alkalmazza a , includeés exclude a leképezéseket: paths kijelöli a szinkronizálni kívánt mappákat, majd includeexclude szűri az ezekben a mappákban található fájlokat. A köteggyökérhez (a include fájl helyéhez) viszonyított írási exclude és databricks.yml gömbölydedségi beállítások megegyeznek azzal, amikor paths nincs beállítva. Amikor egy paths érték áthalad a köteggyökér fölött, és a szinkronizálási gyökér egy közös ősre bővül, a Databricks parancssori felület automatikusan újrahorgonyozza az includeexclude új szinkronizálási gyökérhez, így nem kell módosítania őket.

Az alábbi példa szinkronizálja a mappát és a ../common csomaggyökereket is, minden olyan .whl fájlt tartalmaz, amely .gitignore egyébként kizárna, és egyetlen fájlt zárna ki:

sync:
  paths:
    - ../common
    - .
  include:
    - my_package/dist/*.whl
  exclude:
    - my_package/dist/delete-me.whl

Célok

Type: Map

A csomag üzembehelyezési célkörnyezeteit határozza meg. Mindegyik cél az összetevők, az Azure Databricks-munkaterület beállításai és néha a célspecifikus erőforrás-részletek egyedi gyűjteménye.

A targets leképezés egy vagy több célleképezésből áll, amelyeknek egyedi programozott (vagy logikai) névvel kell rendelkezniük. Ez a leképezés nem kötelező, de erősen ajánlott.

A leképezés beállításai elsőbbséget élveznek a targets legfelső szintű munkaterületen, összetevőkben és erőforrás-leképezésekben megadott beállításokkal szemben.

A célértékek felülbírálhatják a legfelső szintű változók értékeit is.

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Kulcs Típus Leírás
artifacts Térkép A céltelepítésbe tartalmazandó elemek. Lásd: tárgyak.
bundle Térkép A csomagattribútumok a célra való telepítéskor. Lásd a csomagot.
cluster_id Szál A célhoz használatos klaszter azonosítója.
compute_id Szál Elavult. A célhoz használni kívánt számítás azonosítója.
default logikai Azt jelzi, hogy ez-e az alapértelmezett cél. Lásd a célokat.name.default.
git Térkép A cél Git-verziókövetési beállításai. Lásd: git.
mode Szál A cél üzembehelyezési módja. Az érvényes értékek development vagy production. Lásd a célokat.name.mode és deklaratív automation bundles üzembe helyezési módok.
permissions Következés A csomag célban való üzembe helyezésére és futtatására vonatkozó engedélyek. Tekintse meg az engedélyeket.
presets Térkép A cél telepítési beállításai. Lásd a célokat.name.presets.
resources Térkép A cél erőforrás-definíciói. Tekintse meg az erőforrásokat.
run_as Térkép A csomag futtatásához használandó identitás. Lásd : run_as és run identity megadása deklaratív automation-kötegek munkafolyamatához.
sync Térkép A csomag futtatásakor vagy üzembe helyezésekor a cél-munkaterületre szinkronizálandó helyi útvonalak. Lásd szinkron.
variables Térkép A cél egyéni változódefiníciói. Lásd a változókat.
workspace Térkép A Databricks-munkaterület a cél számára. Lásd munkaterület.

Célok. name.default

A csomagparancsok alapértelmezett célértékének megadásához állítsa be a default hozzárendelést true-re. Ez a névvel ellátott dev cél például az alapértelmezett cél:

targets:
  dev:
    default: true

Ha egy alapértelmezett cél nincs konfigurálva, vagy ha egy adott célon belül szeretné ellenőrizni, üzembe helyezni és futtatni a feladatokat vagy folyamatokat, használja a -t csomagparancsok lehetőségét.

A következő parancsok ellenőrzik, telepítik és futtatják my_job a dev és prod célpontban:

databricks bundle validate
databricks bundle deploy -t dev
databricks bundle run -t dev my_job

databricks bundle validate
databricks bundle deploy -t prod
databricks bundle run -t prod my_job

Az alábbi példa két célt deklarál. Az első cél a névvel dev rendelkezik, és az alapértelmezett cél, ha nincs megadva cél a csomagparancsokhoz. A második cél neve prod csak akkor használatos, ha ez a cél a csomagparancsokhoz van megadva.

targets:
  dev:
    default: true
  prod:
    workspace:
      host: https://<production-workspace-url>

Célok. name.mode

Az egyszerű fejlesztés és a CI/CD ajánlott eljárásainak megkönnyítése érdekében a Deklaratív Automation-csomagok üzembehelyezési módokat biztosítanak azokhoz a célokhoz, amelyek alapértelmezett viselkedést adnak az éles üzem előtti és az éles munkafolyamatokhoz. Egyes viselkedések a célok használatával is konfigurálhatók.name.presets.

További információ: Deklaratív Automation-csomagok üzembe helyezési módjai.

Jótanács

A csomagok futtatási identitásainak beállításához megadhatja run_as az egyes célokat a Deklaratív Automation-kötegek munkafolyamatának futtatási identitásának megadása című cikkben leírtak szerint.

Annak megadásához, hogy egy cél fejlesztési célként legyen kezelve, adja hozzá a mode leképezési készletet a development-hez. Ha jelezni szeretné, hogy egy cél gyártási célként legyen kezelve, adja hozzá a mode leképezési csoportot production. Például, a(z) prod nevű cél éles célként van kezelve.

targets:
  prod:
    mode: production

Célok. name.presets

A leképezéssel testre szabhat néhány céltelepítési mode viselkedést presets .

Az elérhető készletek listáját az Egyéni beállítások című témakörben találja.

Az alábbi példa egy testreszabott gyártási célállapotot mutat be, amely előtaggal és címkével látja el az összes gyártási erőforrást.

targets:
  prod:
    mode: production
    presets:
      name_prefix: 'production_' # prefix all resource names with production_
      tags:
        prod: true

Változók

Type: Map

Egyéni változót határoz meg a csomaghoz. Minden változóhoz állítson be egy opcionális leírást, alapértelmezett értéket, hogy az egyéni változó összetett típus-e, vagy keressen rá egy azonosító értékének lekéréséhez az alábbi formátum használatával:

variables:
  <variable-name>:
    description: <variable-description>
    default: <optional-default-value>
    type: <optional-type-value> # "complex" is the only valid value
    lookup:
      <optional-object-type>: <optional-object-name>

Megjegyzés:

A változók stringtípusúaknak tekintendők, hacsak type nincs beállítva complex-re. Lásd: Összetett változó definiálása.

Ha egyéni változóra szeretne hivatkozni a csomagkonfiguráción belül, használja a helyettesítést ${var.<variable_name>}.

Az egyéni változókkal és helyettesítésekkel kapcsolatos további információkért lásd: Helyettesítések és változók a Deklaratív Automation-csomagokban.

Kulcs Típus Leírás
default Bármely A változó alapértelmezett értéke.
description Szál A változó leírása.
lookup Térkép Annak a alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalvagy warehouse objektumnak a neve, amelyhez az azonosítót le szeretné kérni. Lásd a változókat.name.lookup.
type Szál A változó típusa, egyszerű vagy összetett. Csak akkor állítsa be ezt a kulcsot, ha a változó összetett. Érvényes értékek: complex.

Változók. name.lookup

Type: Map

Annak a riasztásnak, a cluster_policy-nek, a fürtnek, az irányítópultnak, az instance_pool-nak, a feladatnak, a metaadattárnak, a folyamatnak, a lekérdezésnek, a service_principal-nak vagy a raktárobjektumnak a neve, amelynek azonosítóját le szeretné kérni. A keresés használatáról további információt az objektum azonosítóértékének lekérése című témakörben talál.

Kulcs Típus Leírás
alert Szál Annak a riasztásnak a neve, amelynek azonosítóját le szeretné kérni.
cluster Szál Annak a fürtnek a neve, amelynek azonosítóját le szeretné kérni.
cluster_policy Szál Annak a cluster_policy nevét kell megadni, amelyhez azonosítót szeretne lekérni.
dashboard Szál Annak az irányítópultnak a neve, amelyhez azonosítót szeretne lekérni.
instance_pool Szál Annak a instance_pool a neve, amelynek azonosítóját le szeretné kérni.
job Szál Annak a feladatnak a neve, amelynek azonosítóját le szeretné kérni.
metastore Szál Annak a metaadattárnak a neve, amelynek azonosítóját le szeretné kérni.
notification_destination Szál Annak az értesítés_célállomásnak a neve, amelynek azonosítóját le szeretné kérni.
Hozzáadva a Databricks CLI 0.236.0-s verziójához
pipeline Szál Annak a csővezetéknek a neve, amelynek azonosítóját le szeretné kérni.
query Szál Annak a lekérdezésnek a neve, amelyhez azonosítót szeretne lekérni.
service_principal Szál Annak a service_principalnak a neve, amelynek az azonosítóját le szeretné kérni.
warehouse Szál Annak a raktárnak a neve, amelynek azonosítóját le szeretné kérni.

munkaterület

Type: Map

Meghatározza a csomaghoz tartozó Databricks-munkaterületet. A csomagkonfigurációs fájl csak egy legfelső szintű workspace leképezést tartalmazhat a nem alapértelmezett Azure Databricks-munkaterületi beállítások megadásához.

Fontos

Az érvényes Databricks-munkaterület-útvonalak vagy /Workspace-val kezdődnek, és a műtermékek esetében a /Volumesis támogatott. Az egyéni munkaterület elérési útjai automatikusan /Workspace előtaggal vannak ellátva, így ha az egyéni elérési úton bármilyen munkaterület-helyettesítést használ, például ${workspace.file_path}, akkor nem kell hozzáadnia /Workspace az elérési úthoz.

Kulcs Típus Leírás
account_id Szál A Databricks-fiók azonosítója.
Hozzáadva a Databricks CLI 0.296.0-s verziójához
artifact_path Szál A munkaterületen az üzembe helyezésekhez és a feladatfuttatásokhoz használandó összetevő elérési útja
auth_type Szál A használni kívánt hitelesítési típus, különösen akkor fontos, ha a Databricks parancssori felület váratlan hitelesítési típusra következtet. Tekintse meg az Azure Databricks-erőforrásokhoz való hozzáférés engedélyezését.
azure_client_id Szál Az Azure-ügyfél azonosítója. Lásd: munkaterület-hitelesítés.
azure_environment Szál Az Azure-környezet. Lásd: munkaterület-hitelesítés.
azure_login_app_id Szál Az Azure bejelentkezési alkalmazás azonosítója. Lásd: munkaterület-hitelesítés.
azure_tenant_id Szál Az Azure-bérlő azonosítója. Lásd: munkaterület-hitelesítés.
azure_use_msi logikai Az MSI használata az Azure-hoz. Lásd: munkaterület-hitelesítés.
azure_workspace_resource_id Szál Az Azure-munkaterület erőforrás-azonosítója. Lásd: munkaterület-hitelesítés.
client_id Szál A munkaterület ügyfélazonosítója. Lásd: munkaterület-hitelesítés.
file_path Szál A munkaterületen az üzembe helyezésekhez és a feladatfuttatásokhoz használandó fájl elérési útja. Lásd : workspace.file_path.
google_service_account Szál A Google szolgáltatásfiók neve. Lásd: munkaterület-hitelesítés.
host Szál A Databricks-munkaterület gazdagépének URL-címe. Tekintse meg a(z) Munkaterület-példányok neveit, URL-címeit és azonosítóit.
A host leképezés beállítása arra utasítja a Databricks parancssori felületét, hogy keressen egy megfelelő profilt a .databrickscfg fájlban, majd a profil mezőivel állapítsa meg, hogy melyik Databricks-hitelesítési típust használja. Ha a fájlban több, egyező mezővel rendelkező host profil található.databrickscfg, akkor a profil megadásához a profile leképezést (vagy --profile a -p parancssori beállításokat) kell használnia.
profile Szál A Databricks-munkaterület profilneve. Lásd : workspace.profile.
resource_path Szál A munkaterület erőforrás-elérési útja
Hozzáadva a Databricks CLI 0.230.0-s verziójához
root_path Szál A Databricks-munkaterület gyökérútvonala. Lásd : workspace.root_path.
state_path Szál A munkaterület állapotának elérési útja. Ez a kulcs alapértelmezés szerint a munkaterület alapértelmezett elérési útjának ${workspace.root}/state felel meg, és a munkaterületen belül a Terraform állapotinformációinak tárolására szolgál az üzembe helyezésekkel kapcsolatban.
workspace_id Egész szám A Databricks-munkaterület azonosítója.
Hozzáadva a Databricks CLI 0.285.0-s verziójához

munkaterület-hitelesítés

A munkaterület-leképezés a használni kívánt Databricks-hitelesítési mechanizmus megadására szolgáló leképezéseket is tartalmazhat. Ha nincsenek megadva a legfelső szintű munkaterület-leképezésben, a munkaterület-leképezésben meg kell adni őket a legfelső szintű célok leképezésének egy vagy több példányának gyermekeként.

  • Az OAuth machine-to-machine (M2M) hitelesítéshez a leképezést client_id használják. Másik lehetőségként beállíthatja ezt az értéket a helyi környezeti változóban DATABRICKS_CLIENT_ID. Létrehozhat egy konfigurációs profilt az client_id értékkel, majd megadhatja a profil nevét a profile leképezéssel a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsok futtatásakor a Databricks parancssori felületen, vagy használhatja a --profile vagy -p opciókat. Lásd: Az Azure Databrickshez való hozzáférés engedélyezése a szolgáltatásnévi objektum számára az OAuth használatával.

    Megjegyzés:

    A csomagkonfigurációs fájlban nem adhat meg Azure Databricks OAuth titkos értéket. Ehelyett állítsa be a helyi környezeti változót DATABRICKS_CLIENT_SECRET. Vagy hozzáadhatja az client_secret értéket egy konfigurációs profilhoz, majd megadhatja a profil nevét a profile leképezéssel, vagy használhatja a --profile vagy -p beállításokat a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsok futtatásakor a Databricks parancssori felülettel.

  • Az Azure CLI-hitelesítéshez a leképezést azure_workspace_resource_id használják. Másik lehetőségként beállíthatja ezt az értéket a helyi környezeti változóban DATABRICKS_AZURE_RESOURCE_ID. Létrehozhat egy konfigurációs profilt az azure_workspace_resource_id értékkel, majd megadhatja a profil nevét a profile leképezéssel a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsok futtatásakor a Databricks parancssori felületen, vagy használhatja a --profile vagy -p opciókat. Lásd : Hitelesítés az Azure CLI-vel.

  • Az Azure ügyfél titkos kódos hitelesítése során szolgáltatásnevek használatával a leképezések azure_workspace_resource_id, azure_tenant_id, és azure_client_id használatosak. Másik lehetőségként beállíthatja ezeket az értékeket a helyi környezeti változókban, DATABRICKS_AZURE_RESOURCE_ID, ARM_TENANT_IDés ARM_CLIENT_ID. Vagy létrehozhat egy konfigurációs profilt a azure_workspace_resource_id, azure_tenant_id és azure_client_id értékekkel, majd megadhatja a profil nevét a profile leképezéssel (vagy a --profile és -p opciók használatával, amikor a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsokat futtatja a Databricks CLI-vel). Lásd Hitelesítés a Microsoft Entra szolgáltatásazonosítókkal.

    Megjegyzés:

    A csomagkonfigurációs fájlban nem adhat meg Azure-ügyfél titkos kódértéket. Ehelyett állítsa be a helyi környezeti változót ARM_CLIENT_SECRET. Vagy hozzáadhatja az azure_client_secret értéket egy konfigurációs profilhoz, majd megadhatja a profil nevét a profile leképezéssel, vagy használhatja a --profile vagy -p beállításokat a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsok futtatásakor a Databricks parancssori felülettel.

  • Az Azure-beli felügyelt identitások hitelesítése esetén a azure_use_msi, azure_client_id és azure_workspace_resource_id leképezések vannak használatban. Másik lehetőségként beállíthatja ezeket az értékeket a helyi környezeti változókban, ARM_USE_MSI, ARM_CLIENT_IDés DATABRICKS_AZURE_RESOURCE_ID. Vagy létrehozhat egy konfigurációs profilt a azure_use_msi, azure_client_id és azure_workspace_resource_id értékekkel, majd megadhatja a profil nevét a profile leképezéssel (vagy a --profile és -p opciók használatával, amikor a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsokat futtatja a Databricks CLI-vel). Lásd : Hitelesítés azure-beli felügyelt identitásokkal.

  • A azure_environment leképezés az Azure-környezet típusát (például Nyilvános, UsGov, Kína és Németország) határozza meg egy adott API-végpontkészlethez. Az alapértelmezett érték a PUBLIC. Másik lehetőségként beállíthatja ezt az értéket a helyi környezeti változóban ARM_ENVIRONMENT. Vagy hozzáadhatja az azure_environment értéket egy konfigurációs profilhoz, majd megadhatja a profil nevét a profile leképezéssel, vagy használhatja a --profile vagy -p beállításokat a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsok futtatásakor a Databricks parancssori felülettel.

  • A azure_login_app_id leképezés nem működik, és belső használatra van fenntartva.

workspace.root_path

Ez a workspace megfeleltetés tartalmazhat egy olyan leképezést root_path , amely egy nem alapértelmezett gyökérelérési útvonalat határoz meg, amelyet a munkaterületen az üzembe helyezésekhez és a munkafolyamat-futtatásokhoz is használni kell, például:

workspace:
  root_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}

Alapértelmezés szerint a Databricks parancssori eszköz a root_path alapértelmezett elérési útvonalat használja, amely /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/${bundle.target} alkalmaz.

Fontos

Ne használjon /Shared elérési utat (például /Shared/.bundle/prod/...) éles környezetként root_path. A /Shared mappát minden munkaterület-felhasználó írhatja, ami azt jelenti, hogy bárki módosíthatja az üzembe helyezett éles kódot, a feladatdefiníciókat és a kódtárakat. Ehelyett helyezzen üzembe egy olyan mappában, amelynek írási hozzáférését a mappa ACL-jei vezérlik, és csak a csomagot üzembe helyező identitáshoz adjon írási hozzáférést.

A Databricks azt javasolja, hogy telepítsen éles csomagokat egy szolgáltatásnévvel , és korlátozza az éles root_path írási hozzáférést az adott szolgáltatásnévre.

workspace.artifact_path

Ez a workspace leképezés olyan leképezést artifact_path is tartalmazhat, amely egy nem alapértelmezett összetevő elérési útját adja meg, amelyet a munkaterületen az üzembe helyezésekhez és a feladatfuttatásokhoz is használni kell, például:

workspace:
  artifact_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/artifacts

Alapértelmezés szerint a Databricks parancssori eszköz a artifact_path alapértelmezett elérési útvonalat használja, amely ${workspace.root}/artifacts alkalmaz.

Megjegyzés:

A artifact_path leképezés nem támogatja a Databricks File System (DBFS) elérési útvonalakat.

workspace.file_path

Ez a workspace leképezés olyan leképezést file_path is tartalmazhat, amely egy nem alapértelmezett fájlelérési útvonalat határoz meg, amelyet a munkaterületen az üzembe helyezésekhez és a feladatfuttatásokhoz is használni kell, például:

workspace:
  file_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/files

Alapértelmezés szerint a Databricks parancssori eszköz a file_path alapértelmezett elérési útvonalat használja, amely ${workspace.root}/files alkalmaz.

Fontos

Ezekhez a hitelesítési értékekhez nem adhat meg egyéni változókat a ${var.*} szintaxis használatával.

workspace.profile

Megjegyzés:

A Databricks azt javasolja, hogy a host leképezés helyett a --profile, -p vagy profile leképezési lehetőségeket használja, amikor a csomag ellenőrzése, üzembe helyezése, futtatása és megsemmisítése parancsokat futtatja a Databricks CLI-vel, mivel ezáltal hordozhatóbbá válnak a csomagkonfigurációs fájlok.

A profile leképezés megadja az Azure Databricks-munkaterületen való hitelesítéshez használandó konfigurációs profil nevét. Ez a konfigurációs profil megfelel a Databricks parancssori felület beállításakor létrehozott profilnak.

Gyakori objektumok

Git

Type: Map

Meghatározza a Git-verziókövetés részleteit. Ez hasznos az üzembehelyezési metaadatok propagálásához, amelyek később felhasználhatók az erőforrások azonosítására. Nyomon követheti például a CI/CD által üzembe helyezett feladatok adattárának eredetét.

Amikor bundle parancsot futtat, például validate, deploy vagy run, a bundle parancs feltölti a parancs konfigurációs fáját az alábbi alapértelmezett beállításokkal.

A Git-beállítások lekéréséhez vagy felülbírálásához a csomagnak egy Git-adattárhoz társított könyvtárban kell lennie, például egy helyi könyvtárban, amelyet a git clone parancs futtatásával inicializál. Ha a könyvtár nincs Git-adattárhoz társítva, ezek a Git-beállítások üresek.

Kulcs Típus Leírás
branch Szál Az aktuális Git-ág neve. Ez ugyanaz az érték, amelyet akkor kapna, ha a klónozott adattárból futtatná a git branch --show-current parancsot. A helyettesítések használatával hivatkozhat erre az értékre a csomagkonfigurációs fájlokkal, például${bundle.git.branch}.
origin_url Szál Az adattár forrás URL-címe. Ez ugyanaz az érték, amelyet akkor kapna, ha a klónozott adattárból futtatná a git config --get remote.origin.url parancsot. A helyettesítések használatával hivatkozhat erre az értékre a csomagkonfigurációs fájlokkal, például${bundle.git.origin_url}.

Példák

Szükség esetén felülbírálhatja a origin_urlbranchgit legfelső szintű bundle leképezés leképezésén belüli beállításokat:

bundle:
  git:
    origin_url: <some-non-default-origin-url>
    branch: <some-non-current-branch-name>
  • Last updated on