Configuratiegids

Dit artikel bevat naslaginformatie over sleutels die worden ondersteund door de configuratie van Databricks Asset Bundles (YAML). Zie Wat zijn Databricks Assetbundels?.

Zie Bundelconfiguratievoorbeelden en de GitHub-opslagplaats met bundelvoorbeeldenvoor volledige bundelvoorbeelden.

Artefacten

Type: Map

Hiermee geeft u de artefacten die automatisch moeten worden gebouwd tijdens bundelimplementaties die later in bundeluitvoeringen kunnen worden gebruikt. Elke sleutel is de naam van het artefact en de waarde is een kaart waarmee de build-instellingen voor artefacten worden gedefinieerd.

Aanbeveling

U kunt de instellingen voor artefacten in bundels definiëren, combineren en overschrijven, zoals beschreven in Onderdrukking met doelinstellingen.

Toegevoegd in Databricks CLI versie 0.229.0

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

Sleutel	Typologie	Beschrijving
build	Snaar	Een optionele set buildopdrachten die lokaal moeten worden uitgevoerd vóór de implementatie. Voor Python-wheel-builds gaat de Databricks CLI ervan uit dat het een lokale installatie van het Python-pakket wheel kan vinden om builds uit te voeren en dat de opdracht python setup.py bdist_wheel standaard wordt uitgevoerd tijdens elke bundelimplementatie. Geef meerdere buildopdrachten op afzonderlijke regels op. Toegevoegd in Databricks CLI versie 0.229.0
dynamic_version	Booleaans	Of de wielversie dynamisch moet worden gepatcht op basis van de tijdstempel van het whl-bestand. Als dit is ingesteld op true, kan nieuwe code worden geïmplementeerd zonder dat u de versie hoeft bij te werken in setup.py of pyproject.toml. Deze instelling is alleen geldig wanneer type is ingesteld op whl. Toegevoegd in Databricks CLI versie 0.245.0
executable	Snaar	Het uitvoerbare type. Geldige waarden zijn bash, shen cmd. Toegevoegd in Databricks CLI versie 0.229.0
files	Volgorde	Het relatieve of absolute pad naar de gebouwde artefact bestanden. Zie artefacten.name.files. Toegevoegd in Databricks CLI versie 0.229.0
path	Snaar	Het lokale pad van de map voor het artefact. Paden zijn relatief ten opzichte van de locatie van het bundelconfiguratiebestand. Voor Python wheel-builds is het pad naar het setup.py Python-wielbestand. Als path niet is inbegrepen, probeert de Databricks CLI het Python-wielbestand met de naam setup.py te vinden in de hoofdmap van de bundel. Toegevoegd in Databricks CLI versie 0.229.0
type	Snaar	Vereist als het artefact een Python-wiel is. Het type artefact. Geldige waarden zijn whl en jar. Deze instelling hoeft niet te worden opgegeven om andere artefacten te bouwen. Toegevoegd in Databricks CLI versie 0.229.0

Voorbeelden

Met de volgende configuratie wordt een Python-wiel gebouwd met behulp van Poëzie:

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

De volgende configuratie voert tests uit en bouwt een wiel. Zie artifacts voor een volledige bundelzelfstudie die gebruikmaakt van het bouwen van een wiel.

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

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

Zie Bundle waarmee een JAR-bestand wordt geüpload naar Unity Catalog, voor een voorbeeldconfiguratie waarmee een JAR-bestand wordt geüpload naar Unity Catalog.

Artefacten. name.files

Type: Sequence

Het relatieve of absolute pad naar de gebouwde artefact bestanden. Gebruik source dit om de ingebouwde artefacten op te geven. Paden zijn relatief ten opzichte van de locatie van het bundelconfiguratiebestand.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
source	Snaar	Vereist. Het artefact-bronbestand. Toegevoegd in Databricks CLI versie 0.229.0

bundel

Type: Map

De bundelkenmerken voor implementatie naar deze doelomgeving.

Een configuratiebestand voor bundels mag slechts één toewijzing op het hoogste niveau bundle bevatten.

Deze bundle toewijzing moet een name toewijzing bevatten die een programmatische (of logische) naam voor de bundel aangeeft. In het volgende voorbeeld wordt een bundel met de programmatische (of logische) naam hello-bundle gedeclareerd.

bundle:
  name: hello-bundle

Een bundle toewijzing kan ook een onderdeel zijn van een of meer doelen in de doelen-toewijzing op het hoogste niveau. Elk van deze onderliggende bundle toewijzingen specificeert eventuele niet-standaard overschrijvingen op doelniveau.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
cluster_id	Snaar	De id van een cluster dat moet worden gebruikt om de bundel uit te voeren. Met deze sleutel kunt u de id van een cluster opgeven die moet worden gebruikt als onderdrukking voor clusters die elders in het bundelconfiguratiebestand zijn gedefinieerd. Zie de URL en id van een rekenresource voor informatie over het ophalen van de id van een cluster. De cluster_id override is bedoeld voor uitsluitend ontwikkelingsscenario's en wordt alleen ondersteund voor het doel dat zijn mode-toewijzing op development heeft ingesteld. Voor meer informatie over de target-toewijzing, zie doelen. Toegevoegd in Databricks CLI versie 0.229.0
compute_id	Snaar	Verouderd. De ID van het computing systeem dat moet worden gebruikt om de bundel uit te voeren. Toegevoegd in Databricks CLI versie 0.229.0
databricks_cli_version	Snaar	De Databricks CLI-versie die moet worden gebruikt voor de bundel. Zie bundle.databricks_cli_version. Toegevoegd in Databricks CLI versie 0.229.0
deployment	Kaart	De definitie van de bundelimplementatie. Zie de implementatiemodi databricks Asset Bundle voor ondersteunde kenmerken. Zie bundle.deployment. Toegevoegd in Databricks CLI versie 0.229.0
git	Kaart	De details van het Git-versiebeheer die aan uw bundel zijn gekoppeld. Zie Git voor ondersteunde kenmerken. Toegevoegd in Databricks CLI versie 0.229.0
name	Snaar	De naam van de bundel. Toegevoegd in Databricks CLI versie 0.229.0
uuid	Snaar	Gereserveerd. Een UUID (Universally Unique Identifier) voor de bundel die de bundel uniek identificeert in interne Databricks-systemen. Dit wordt gegenereerd wanneer een bundelproject wordt geïnitialiseerd met behulp van een Databricks-sjabloon (met behulp van de opdracht databricks bundle init). Toegevoegd in Databricks CLI versie 0.236.0

bundle.databricks_cli_version

De bundle toewijzing kan een databricks_cli_version toewijzing bevatten die de Databricks CLI-versie beperkt die is vereist voor de bundel. Dit kan problemen voorkomen die ontstaan door het gebruik van koppelingen die niet worden ondersteund in een bepaalde versie van de CLI van Databricks.

De Databricks CLI-versie voldoet aan semantisch versiebeheer en de databricks_cli_version toewijzing maakt het mogelijk om versiebeperkingen op te geven. Als de huidige databricks --version waarde zich niet binnen de grenzen bevindt die zijn opgegeven in de databricks_cli_version-koppeling van de bundel, treedt er een fout op wanneer databricks bundle validate op de bundel wordt uitgevoerd. In de volgende voorbeelden ziet u enkele algemene syntaxis voor versiebeperkingen:

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

De definitie van de bundelimplementatie

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
fail_on_active_runs	Booleaans	Of het uitvoeren van actieve uitvoeringen mislukt. Als dit is ingesteld op 'true', kan een implementatie die wordt uitgevoerd worden onderbroken. Toegevoegd in Databricks CLI versie 0.229.0
lock	Kaart	De inzetvergrendelingsattributen. Zie bundle.deployment.lock. Toegevoegd in Databricks CLI versie 0.229.0

bundle.deployment.lock

Type: Map

De inzetvergrendelingsattributen.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
enabled	Booleaans	Of deze vergrendeling is ingeschakeld. Toegevoegd in Databricks CLI versie 0.229.0
force	Booleaans	Of deze vergrendeling moet worden afgedwongen als deze is ingeschakeld. Toegevoegd in Databricks CLI versie 0.229.0

experimenteel

Type: Map

Definieert kenmerken voor experimentele functies.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
python	Kaart	Verouderd. Gebruik de python-mapping op het hoogste niveau in plaats daarvan. Toegevoegd in Databricks CLI versie 0.238.0
python_wheel_wrapper	Booleaans	Of u een Python wiel-wrapper wilt gebruiken. Toegevoegd in Databricks CLI versie 0.229.0
scripts	Kaart	De opdrachten die moeten worden uitgevoerd. Toegevoegd in Databricks CLI versie 0.229.0
skip_artifact_cleanup	Booleaans	Bepaalt of de .internal map in de map moet workspace.artifact_pathworden overgeslagen. Deze map wordt standaard verwijderd voordat u nieuwe buildartefacten (zoals Python-wielen) uploadt tijdens de implementatie. Ingesteld om true bestaande artefacten in implementaties te behouden. Toegevoegd in Databricks CLI versie 0.254.0
skip_name_prefix_for_schema	Booleaans	Of u het voorvoegsel (ingesteld in presets.name_prefix of berekend wanneer mode: development) wilt overslaan naar de namen van Unity Catalog-schema's die in de bundel zijn gedefinieerd. Toegevoegd in Databricks CLI versie 0.255.0
use_legacy_run_as	Booleaans	Of u het oudere run_as gedrag wilt gebruiken. Toegevoegd in Databricks CLI versie 0.229.0

opnemen

Type: Sequence

Hiermee geeft u een lijst met pad globs die configuratiebestanden bevatten die in de bundel moeten worden opgenomen. Deze padglobs zijn relatief ten opzichte van de locatie van het bundelconfiguratiebestand waarin de padglobs worden opgegeven. Afgezien van databricks.yml, moet u de include matrix gebruiken om alle configuratiebestanden op te geven die in de bundel moeten worden opgenomen.

Aanbeveling

Als u andere bestanden in de bundel wilt opnemen of uitsluiten, gebruikt u opnemen en uitsluiten.

Deze include array kan alleen voorkomen als een top-level mapping.

Toegevoegd in Databricks CLI versie 0.229.0

De volgende voorbeeldconfiguratie bevat drie configuratiebestanden. Deze bestanden bevinden zich in dezelfde map als het bundelconfiguratiebestand:

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

De volgende voorbeeldconfiguratie bevat alle bestanden met bestandsnamen die beginnen met bundle en eindigen met .yml. Deze bestanden bevinden zich in dezelfde map als het bundelconfiguratiebestand:

include:
  - 'bundle*.yml'

Machtigingen

Type: Sequence

Definieert de machtigingen die moeten worden toegepast op resources die zijn gedefinieerd in de bundel, waarbij elk item in de reeks een machtiging is voor een specifieke entiteit. Zie machtigingen instellen voor resources in Databricks Asset Bundles.

Toegestane machtigingsniveaus op het hoogste niveau zijn CAN_VIEW, CAN_MANAGEen CAN_RUN.

Als u machtigingen wilt toepassen op een specifieke resource, raadpleegt u Machtigingen definiëren voor een specifieke resource.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
group_name	Snaar	De naam van de groep waarvoor de machtigingen per niveau zijn ingesteld. Toegevoegd in Databricks CLI versie 0.229.0
level	Snaar	De toestemmingen voor gebruiker, groep en service-principal die voor deze machtiging zijn gedefinieerd. Geldige waarden voor deze sleutel verschillen, afhankelijk van of de machtigingen zijn gedefinieerd op het hoogste niveau van de bundel of voor een specifieke resource. Zie machtigingen instellen voor resources in Databricks Asset Bundles. Toegevoegd in Databricks CLI versie 0.229.0
service_principal_name	Snaar	De naam van de service-principal met de machtigingen die op niveau zijn ingesteld. Toegevoegd in Databricks CLI versie 0.229.0
user_name	Snaar	De naam van de gebruiker die de machtiging op een bepaald niveau heeft ingesteld. Toegevoegd in Databricks CLI versie 0.229.0

Voorbeeld

In de volgende voorbeeldconfiguratie worden machtigingsniveaus gedefinieerd voor een gebruiker, groep en service-principal, die worden toegepast op alle resources die in resources de bundel zijn gedefinieerd:

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

Voorinstellingen

Type: Map

Definieert vooraf ingestelde bundelimplementaties. Zie Aangepaste voorinstellingen voor meer informatie.

Tenzij er een uitzondering is opgegeven voor een vooraf ingestelde instelling, overschrijven modepresets vooraf ingestelde instellingen het gedrag van de standaardmodus en instellingen van afzonderlijke resources de vooraf ingestelde instellingen.

Toegevoegd in Databricks CLI versie 0.229.0

Vooraf ingestelde	Beschrijving
artifacts_dynamic_version	Of de versie van whl artefacten dynamisch moet worden bijgewerkt tijdens de implementatie. Geldige waarden zijn true of false. Als de artifacts.dynamic_version configuratie-instelling op het hoogste niveau is opgegeven, wordt deze voorinstelling overschreven. Toegevoegd in Databricks CLI versie 0.256.0
jobs_max_concurrent_runs	Het aantal maximaal toegestane gelijktijdige uitvoeringen voor taken. Toegevoegd in Databricks CLI versie 0.229.0
name_prefix	De voorvoegseltekenreeks die moet worden toegevoegd aan resourcenamen. Toegevoegd in Databricks CLI versie 0.229.0
pipelines_development	Of pijplijnimplementaties moeten worden vergrendeld in de ontwikkelingsmodus. Geldige waarden zijn true of false. Toegevoegd in Databricks CLI versie 0.229.0
source_linked_deployment	Of de resources die tijdens de implementatie zijn gemaakt naar de bronbestanden in de werkruimte verwijzen in plaats van naar hun kopieën in de werkruimte. Toegevoegd in Databricks CLI versie 0.236.0
tags	Een set sleutel-waardetags die van toepassing zijn op alle resources die tags ondersteunen, waaronder taken en experimenten. Databricks Asset Bundles biedt geen ondersteuning voor tags voor de schema resource. Toegevoegd in Databricks CLI versie 0.229.0
trigger_pause_status	Een onderbrekingsstatus die moet worden toegepast op alle triggers en planningen. Geldige waarden zijn PAUSED of UNPAUSED. Als mode is ingesteld op development, dan is trigger_pause_status altijd PAUSED. Toegevoegd in Databricks CLI versie 0.229.0

Python

Type: Map

Hiermee configureert u het laden van Python-code die is gedefinieerd met het databricks-bundles-pakket. Zie Bundelconfiguratie in Python voor meer informatie.

Verplaatst van experimental in Databricks CLI versie 0.275.0

Sleutel	Typologie	Beschrijving
mutators	Volgorde	Mutators bevatten een lijst met volledig gekwalificeerde functiepaden voor mutatorfuncties, zoals [my_project.mutators:add_default_cluster]. Toegevoegd in Databricks CLI versie 0.238.0
resources	Volgorde	Resources bevatten een lijst met volledig gekwalificeerde functiepaden voor het laden van resources die zijn gedefinieerd in Python-code, zoals ["my_project.resources:load_resources"] Toegevoegd in Databricks CLI versie 0.238.0
venv_path	Snaar	Het pad naar de virtuele omgeving. Indien ingeschakeld, wordt Python-code uitgevoerd in deze omgeving. Als deze optie is uitgeschakeld, wordt standaard de Python-interpreter gebruikt die beschikbaar is in de huidige shell. Toegevoegd in Databricks CLI versie 0.238.0

middelen

Type: Map

Definieert de resources voor de bundel, waarbij elke sleutel de naam van de resource is en de waarde een kaart is waarmee de resource wordt gedefinieerd. Zie Databricks Asset Bundles-resourcesvoor meer informatie over ondersteunde resources, en de referentie voor resource-definities van Databricks Asset Bundles.

De resources toewijzing kan worden weergegeven als een toewijzing op het hoogste niveau of kan een onderliggend element zijn van een of meer doelen in de toewijzing van doelen op het hoogste niveau en bevat nul of een van de ondersteunde resourcetypen. Elke mapping van resource-typen bevat een of meer individuele resource declaraties, die elk een unieke naam moeten hebben. Deze individuele resourcedeclaraties maken gebruik van de aanvraagpayload van de aanmaakbewerking van het overeenkomende object, uitgedrukt in YAML, om de resource vast te stellen. Ondersteunde eigenschappen voor een resource zijn de ondersteunde velden van het bijbehorende object.

Payloads voor het maken van bewerkingsverzoeken worden gedocumenteerd in de Databricks REST API-referentie, en het databricks bundle schema commando geeft alle ondersteunde objectschema's weer. Bovendien retourneert de databricks bundle validate opdracht waarschuwingen als onbekende resource-eigenschappen worden gevonden in bundelconfiguratiebestanden.

Zie voor meer informatie over resources die worden ondersteund in bundels, evenals algemene configuratie en voorbeelden, Databricks Asset Bundles-resources en Bundelconfiguratievoorbeelden.

Toegevoegd in Databricks CLI versie 0.229.0

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

Sleutel	Typologie	Beschrijving
alerts	Kaart	De waarschuwingsdefinities (v2) voor de bundel, waarbij elke sleutel de naam van de waarschuwing is. Zie waarschuwing. Toegevoegd in Databricks CLI versie 0.279.0
apps	Kaart	De Databricks-app-definities voor de bundel, waarbij elke sleutel de naam van de app is. Bekijk de app. Toegevoegd in Databricks CLI versie 0.239.0
catalogs	Kaart	De catalogusdefinities (Unity Catalog) voor de bundel, waarbij elke sleutel de naam van een catalogus is. Bekijk catalogi. Toegevoegd in Databricks CLI versie 0.287.0
clusters	Kaart	De clusterdefinities voor de bundel, waarbij elke sleutel de naam van een cluster is. Zie cluster. Toegevoegd in Databricks CLI versie 0.229.0
dashboards	Kaart	De dashboarddefinities voor de bundel, waarbij elke sleutel de naam van het dashboard is. Zie dashboard. Toegevoegd in Databricks CLI versie 0.232.0
database_catalogs	Kaart	De databasecatalogusdefinities voor de bundel, waarbij elke sleutel de naam van de databasecatalogus is. Zie database_catalog. Toegevoegd in Databricks CLI versie 0.265.0
database_instances	Kaart	De definities van het database-exemplaar voor de bundel, waarbij elke sleutel de naam is van het database-exemplaar. Zie database_instance. Toegevoegd in Databricks CLI versie 0.265.0
experiments	Kaart	De experimentdefinities voor de bundel, waarbij elke sleutel de naam van het experiment is. Zie experiment. Toegevoegd in Databricks CLI versie 0.229.0
jobs	Kaart	De taakdefinities voor de bundel, waarbij elke sleutel de naam van de taak is. Zie de taak. Toegevoegd in Databricks CLI versie 0.229.0
model_serving_endpoints	Kaart	Het model dat eindpuntdefinities voor de bundel bedient, waarbij elke sleutel de naam is van het eindpunt dat het model bedient. Zie model_serving_endpoint. Toegevoegd in Databricks CLI versie 0.229.0
models	Kaart	De modeldefinities voor de bundel, waarbij elke sleutel de naam van het model is. Zie model (verouderd). Toegevoegd in Databricks CLI versie 0.229.0
pipelines	Kaart	De pijplijndefinities voor de bundel, waarbij elke sleutel de naam van de pijplijn is. Zie de pijplijn. Toegevoegd in Databricks CLI versie 0.229.0
postgres_branches	Kaart	De Postgres-vertakkingsdefinities voor de bundel, waarbij elke sleutel de naam is van de Lakebase-vertakking. Zie postgres_branch. Toegevoegd in Databricks CLI versie 0.287.0
postgres_endpoints	Kaart	De Postgres-eindpuntdefinities voor de bundel, waarbij elke sleutel de naam is van het Lakebase-rekeneindpunt. Zie postgres_endpoint. Toegevoegd in Databricks CLI versie 0.287.0
postgres_projects	Kaart	De Postgres-projectdefinities voor de bundel, waarbij elke sleutel de naam is van het Lakebase-project. Zie postgres_project. Toegevoegd in Databricks CLI versie 0.287.0
quality_monitors	Kaart	De kwaliteitsmonitordefinities voor de bundel, waarbij elke sleutel de naam is van de kwaliteitsmonitor. Zie quality_monitor (Unity Catalog). Toegevoegd in Databricks CLI versie 0.229.0
registered_models	Kaart	De geregistreerde modeldefinities voor de bundel, waarbij elke sleutel de naam is van het geregistreerde Unity Catalog-model. Zie registered_model (Unity Catalog). Toegevoegd in Databricks CLI versie 0.229.0
schemas	Kaart	De schemadefinities voor de bundel, waarbij elke sleutel de naam van het schema is. Zie schema (Unity Catalog). Toegevoegd in Databricks CLI versie 0.229.0
secret_scopes	Kaart	De geheime bereikdefinities voor de bundel, waarbij elke sleutel de naam is van het geheime bereik. Zie secret_scope. Toegevoegd in Databricks CLI versie 0.252.0
sql_warehouses	Kaart	De SQL Warehouse-definities voor de bundel, waarbij elke sleutel de naam van het SQL Warehouse is. Zie sql_warehouse. Toegevoegd in Databricks CLI versie 0.260.0
synced_database_tables	Kaart	De gesynchroniseerde databasetabeldefinities voor de bundel, waarbij elke sleutel de naam van de databasetabel is. Zie synced_database_table. Toegevoegd in Databricks CLI versie 0.266.0
volumes	Kaart	De volumedefinities voor de bundel, waarbij elke sleutel de naam van het volume is. Zie volume (Unity Catalog). Toegevoegd in Databricks CLI versie 0.236.0

Voorbeeld

In de volgende voorbeeldconfiguratie wordt een taakresource gedefinieerd:

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

uitvoeren als

Type: Map

De identiteit (user_name of service_principal_name) die moet worden gebruikt om Databricks Asset Bundles-werkstromen uit te voeren. Het biedt de mogelijkheid om de identiteit te scheiden die wordt gebruikt om een bundeltaak of pijplijn te implementeren van de identiteit die wordt gebruikt om de taak of pijplijn uit te voeren. Zie Een uitvoeringsidentiteit opgeven voor een Databricks Asset Bundles-werkstroom.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
service_principal_name	Snaar	De toepassings-id van een actieve service-principal. Voor het instellen van dit veld is de servicePrincipal/user rol vereist. Toegevoegd in Databricks CLI versie 0.229.0
user_name	Snaar	Het e-mailadres van een actieve werkruimtegebruiker. Niet-beheerders kunnen dit veld alleen instellen op hun eigen e-mail. Toegevoegd in Databricks CLI versie 0.229.0

Scripts

Type: Map

De scripts die kunnen worden uitgevoerd met behulp van bundle run. Elk script met naam in de scripts toewijzing bevat inhoud met opdrachten. Zie Scripts uitvoeren.

Toegevoegd in Databricks CLI versie 0.259.0

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>

Sleutel	Typologie	Beschrijving
content	Snaar	De opdrachten die moeten worden uitgevoerd Toegevoegd in Databricks CLI versie 0.259.0

Voorbeelden

scripts:
  my_script:
    content: uv run pytest -m ${bundle.target}

synchroniseren

Type: Map

De bestanden en bestandspaden die in de bundel moeten worden opgenomen of uitgesloten.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
exclude	Volgorde	Een lijst met bestanden of mappen die moeten worden uitgesloten van de bundel. Zie opnemen en uitsluiten. Toegevoegd in Databricks CLI versie 0.229.0
include	Volgorde	Een lijst met bestanden of mappen die moeten worden opgenomen in de bundel. Zie opnemen en uitsluiten. Toegevoegd in Databricks CLI versie 0.229.0
paths	Volgorde	De lokale mappaden, die zich buiten de hoofdmap van de bundel kunnen bevinden, om te synchroniseren met de werkruimte wanneer de bundel wordt geïmplementeerd. Zie sync.paths. Toegevoegd in Databricks CLI versie 0.229.0

opnemen en uitsluiten

De include- en exclude-toewijzingen binnen de sync-toewijzing geeft een lijst met bestanden of mappen op die moeten worden opgenomen in of moeten worden uitgesloten van bundelimplementaties, afhankelijk van de volgende regels:

• Op basis van een lijst met bestands- en padglobs in een .gitignore bestand in de hoofdmap van de bundel, kan de include toewijzing een lijst bevatten met bestandsglobs, padglobs, of beide, die ten opzichte van de hoofdmap van de bundel expliciet moeten worden opgenomen.
• Op basis van een lijst met bestands- en padglobs in een .gitignore bestand in de root van de bundel, plus de lijst met bestands- en padglobs in de include toewijzing, kan de exclude toewijzing een lijst bevatten van bestandsglobs, padglobs of beide, die relatief ten opzichte van de root van de bundel expliciet uitgesloten moeten worden.

Alle paden naar opgegeven bestanden en mappen zijn relatief ten opzichte van de locatie van het bundelconfiguratiebestand waarin ze zijn opgegeven.

De syntaxis voor include en exclude bestands- en padpatronen volgen de standaardpatroonsyntaxis .gitignore . Zie gitignore Pattern Format.

Als het volgende .gitignore bestand bijvoorbeeld de volgende vermeldingen bevat:

.databricks
my_package/dist

Het configuratiebestand voor de bundel bevat de volgende include toewijzing:

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

Vervolgens worden alle bestanden in de my_package/dist map met de bestandsextensie *.whl opgenomen. Alle andere bestanden in de my_package/dist map zijn niet opgenomen.

Maar als het configuratiebestand van de bundel ook de volgende exclude mapping bevat:

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

Vervolgens worden alle bestanden in de my_package/dist map met een bestandsextensie van *.whl, behalve het bestand met de naam delete-me.whl, opgenomen. Alle andere bestanden in de my_package/dist map zijn ook niet opgenomen.

De sync mapping kan ook worden gedeclareerd in de targets mapping voor een specifiek doelwit. Elke sync toewijzing die in een doel is gedeclareerd, wordt samengevoegd met een topniveaudeclaratie van sync. Als u bijvoorbeeld verdergaat met het voorgaande voorbeeld, wordt de volgende include toewijzing op niveau targets samengevoegd met de include toewijzing in de toewijzing op het hoogste niveau sync :

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

sync.paths

De sync toewijzing kan een paths toewijzing bevatten waarmee lokale paden worden opgegeven die moeten worden gesynchroniseerd met de werkruimte. Met de paths toewijzing kunt u algemene bestanden delen tussen bundels en kunt u bestanden synchroniseren die zich buiten de hoofdmap van de bundel bevinden. (De hoofdmap van de bundel is de locatie van het databricks.yml-bestand.) Dit is vooral handig wanneer u één opslagplaats hebt die als host fungeert voor meerdere bundels en bibliotheken, codebestanden of configuratie wilt delen.

Opgegeven paden moeten relatief zijn ten opzichte van bestanden en mappen die zijn verankerd in de map waarin de paths toewijzing is ingesteld. Als een of meer padwaarden door de map omhoog gaan naar een voorouder van de bundelmap, wordt het hoofdpad dynamisch bepaald om de mapstructuur intact te houden. Als de hoofdmap van de bundel bijvoorbeeld de naam my_bundle heeft, synchroniseert deze configuratie databricks.yml de common map die zich één niveau boven de hoofdmap van de bundel bevindt en de hoofdmap van de bundel zelf:

sync:
  paths:
    - ../common
    - .

Een implementatie van deze bundel resulteert in de volgende mapstructuur in de werkruimte:

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

Doelstellingen

Type: Map

Definieert doelcontexten voor de implementatie voor de bundel. Elk doel is een unieke verzameling artefacten, azure Databricks-werkruimte-instellingen en soms doelspecifieke resourcedetails.

De targets toewijzing bestaat uit een of meer doeltoewijzingen, die elk een unieke programmatische (of logische) naam moeten hebben. Deze toewijzing is optioneel, maar wordt ten zeerste aanbevolen.

De instellingen in de targets toewijzing hebben voorrang op instellingen die zijn opgegeven in de werkruimte op het hoogste niveau, artefacten en resourcestoewijzingen .

Een doel kan ook de waarden van variabelen op het hoogste niveau overschrijven.

Toegevoegd in Databricks CLI versie 0.229.0

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

Sleutel	Typologie	Beschrijving
artifacts	Kaart	De artefacten die moeten worden opgenomen in de doelimplementatie. Zie artefacten. Toegevoegd in Databricks CLI versie 0.229.0
bundle	Kaart	De bundelkenmerken voor implementatie naar deze doelomgeving. Zie bundel. Toegevoegd in Databricks CLI versie 0.229.0
cluster_id	Snaar	De id van het cluster dat voor dit doel moet worden gebruikt. Toegevoegd in Databricks CLI versie 0.229.0
compute_id	Snaar	Verouderd. De ID van de computereenheid die voor dit doel moet worden gebruikt.
default	Booleaans	Of dit doel het standaarddoel is. Zie doelen.name.default. Toegevoegd in Databricks CLI versie 0.229.0
git	Kaart	De instellingen voor Git-versiebeheer voor het doel. Zie git. Toegevoegd in Databricks CLI versie 0.229.0
mode	Snaar	De implementatiemodus voor het doel. Geldige waarden zijn development of production. Zie doelen.name.mode en Databricks Asset Bundle-implementatiemodi. Toegevoegd in Databricks CLI versie 0.229.0
permissions	Volgorde	De machtigingen voor het implementeren en uitvoeren van de bundel in het doelsysteem. Zie machtigingen. Toegevoegd in Databricks CLI versie 0.229.0
presets	Kaart	De voorinstellingen voor implementatie voor het doelwit. Zie doelen.name.presets. Toegevoegd in Databricks CLI versie 0.229.0
resources	Kaart	De hulpmiddeldefinities voor het beoogde doel. Zie de resources. Toegevoegd in Databricks CLI versie 0.229.0
run_as	Kaart	De identiteit die moet worden gebruikt om de bundel uit te voeren. Zie run_as en geef een uitvoeringsidentiteit op voor een Databricks Asset Bundles-werkstroom. Toegevoegd in Databricks CLI versie 0.229.0
sync	Kaart	De lokale paden voor synchronisatie met de doelwerkruimte wanneer een bundel wordt uitgevoerd of geïmplementeerd. Zie synchronisatie. Toegevoegd in Databricks CLI versie 0.229.0
variables	Kaart	De aangepaste variabeledefinities voor het doel. Zie variabelen. Toegevoegd in Databricks CLI versie 0.229.0
workspace	Kaart	De Databricks-werkruimte voor de beoogde doelstelling. Zie werkruimte. Toegevoegd in Databricks CLI versie 0.229.0

Doelstellingen. name.default

Als u een standaarddoel wilt opgeven voor bundelcommando's, stel de default toewijzing in op true. Dit doel met de naam dev is bijvoorbeeld het standaarddoel:

targets:
  dev:
    default: true

Als een standaarddoel niet is geconfigureerd of als u taken of pijplijnen binnen een specifiek doel wilt valideren, implementeren en uitvoeren, gebruikt u de -t optie van de bundelopdrachten.

De volgende opdrachten valideren, implementeren en uitvoeren my_job binnen de dev en prod doelen:

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

In het volgende voorbeeld worden twee doelen gedeclareerd. Het eerste doel heeft de naam dev en is het standaarddoel dat wordt gebruikt wanneer er geen doel is opgegeven voor bundelopdrachten. Het tweede doel heeft de naam prod en wordt alleen gebruikt wanneer dit doel is opgegeven voor bundelopdrachten.

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

Doelstellingen. name.mode

Om eenvoudige ontwikkel- en CI/CD-best practices mogelijk te maken, biedt Databricks Asset Bundles implementatiemodi voor doelen die standaardgedrag instellen voor preproductie- en productiewerkstromen. Sommige gedragingen kunnen ook worden geconfigureerd met behulp van doelen.name.presets.

Zie de implementatiemodi voor Databricks Asset Bundle voor meer informatie.

Aanbeveling

Als u uitvoeringsidentiteiten voor bundels wilt instellen, kunt u run_as specificeren voor elk doel, zoals beschreven in Een uitvoeringsidentiteit opgeven voor een Databricks Asset Bundles-werkstroom.

Als u wilt opgeven dat een doel wordt behandeld als een ontwikkelingsdoel, voegt u de mode toewijzingsset toe aan development. Als u wilt aangeven dat een doel wordt behandeld als een productiedoel, voegt u de mode koppelingsset toe aan production. Dit doel met de naam prod wordt bijvoorbeeld behandeld als een productiedoel:

targets:
  prod:
    mode: production

Doelstellingen. name.presets

U kunt enkele van de doelimplementatiegedrag mode aanpassen met behulp van de presets toewijzing.

Zie Aangepaste voorinstellingen voor een lijst met beschikbare voorinstellingen.

In het volgende voorbeeld ziet u een aangepast productiedoel waarmee alle productiebronnen worden voorafgegaan en gelabeld:

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

Variabelen

Type: Map

Hiermee definieert u een aangepaste variabele voor de bundel. Stel voor elke variabele een optionele beschrijving, standaardwaarde in, of de aangepaste variabele een complex type is of zoekactie om een id-waarde op te halen, met behulp van de volgende indeling:

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>

Opmerking

Variabelen worden ervan uitgegaan dat ze van het type stringzijn, tenzij type deze is ingesteld op complex. Zie Een complexe variabele definiëren.

Als u wilt verwijzen naar een aangepaste variabele in de bundelconfiguratie, gebruikt u de vervanging ${var.<variable_name>}.

Zie Vervangingen en variabelen in Databricks Asset Bundles voor meer informatie over aangepaste variabelen en vervangingen.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
default	Welke dan ook	De standaardwaarde voor de variabele. Toegevoegd in Databricks CLI versie 0.229.0
description	Snaar	De beschrijving van de variabele. Toegevoegd in Databricks CLI versie 0.229.0
lookup	Kaart	De naam van de alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalof warehouse object waarvoor een id moet worden opgehaald. Zie variabelen.name.lookup. Toegevoegd in Databricks CLI versie 0.229.0
type	Snaar	Het type variabele, eenvoudig of complex. Stel deze sleutel alleen in als de variabele complex is. Geldige waarden: complex. Toegevoegd in Databricks CLI versie 0.229.0

Variabelen. name.lookup

Type: Map

De naam van de waarschuwing, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pijplijn, query, service_principal of magazijnobject waarvoor een id moet worden opgehaald. Zie De id-waarde van een object ophalen voor informatie over het gebruik van opzoeken.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
alert	Snaar	De naam van de waarschuwing waarvoor de ID moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
cluster	Snaar	De naam van het cluster waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
cluster_policy	Snaar	De naam van de cluster_policy waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
dashboard	Snaar	De naam van het dashboard waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
instance_pool	Snaar	De naam van de instance_pool waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
job	Snaar	De naam van de taak waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
metastore	Snaar	De naam van de metastore waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
notification_destination	Snaar	De naam van de notification_destination waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.236.0
pipeline	Snaar	De naam van de pijplijn waarvoor een ID moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
query	Snaar	De naam van de query waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
service_principal	Snaar	De naam van de service_principal waarvoor een id moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0
warehouse	Snaar	De naam van het magazijn waarvoor een ID moet worden opgehaald. Toegevoegd in Databricks CLI versie 0.229.0

Werkruimte

Type: Map

Hiermee definieert u de Databricks-werkruimte voor de bundel. Het configuratiebestand voor bundels kan slechts één toewijzing op het hoogste niveau workspace bevatten om eventuele niet-standaardinstellingen voor Azure Databricks-werkruimten op te geven die moeten worden gebruikt.

Belangrijk

Geldige Databricks-werkruimtepaden beginnen met /Workspace, of voor artefacten wordt /Volumesook ondersteund. Aangepaste werkruimtepaden worden automatisch voorafgegaan door /Workspace, dus als u een vervanging van het werkruimtepad in uw aangepaste pad gebruikt, zoals ${workspace.file_path}, hoeft u /Workspace niet aan het pad toe te voegen.

Toegevoegd in Databricks CLI versie 0.229.0

Sleutel	Typologie	Beschrijving
artifact_path	Snaar	Het artefactpad dat in de werkruimte gebruikt wordt voor zowel implementaties als werkstroomruns Toegevoegd in Databricks CLI versie 0.229.0
auth_type	Snaar	Het verificatietype dat moet worden gebruikt, met name belangrijk in gevallen waarin de Databricks CLI een onverwacht verificatietype afwijst. Zie de sectie Toegang verlenen tot Azure Databricks-resources. Toegevoegd in Databricks CLI versie 0.229.0
azure_client_id	Snaar	De Azure-client-id. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
azure_environment	Snaar	De Azure-omgeving. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
azure_login_app_id	Snaar	De aanmeldings-app-id van Azure. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
azure_tenant_id	Snaar	De Azure tenant-ID. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
azure_use_msi	Booleaans	Of u MSI wilt gebruiken voor Azure. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
azure_workspace_resource_id	Snaar	De resource-id van de Azure-werkruimte. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
client_id	Snaar	De client-id voor de werkruimte. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
file_path	Snaar	Het bestandspad dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen. Zie workspace.file_path. Toegevoegd in Databricks CLI versie 0.229.0
google_service_account	Snaar	De naam van het Google-serviceaccount. Zie werkruimteverificatie. Toegevoegd in Databricks CLI versie 0.229.0
host	Snaar	De Host-URL van de Databricks-werkruimte. Zie de namen, URL's en ID's van Werkruimte-instanties. Als u de host toewijzing instelt, krijgt de Databricks CLI de opdracht om een overeenkomend profiel in uw .databrickscfg bestand te vinden en vervolgens de velden van dat profiel te gebruiken om te bepalen welk Databricks-verificatietype moet worden gebruikt. Als er meerdere profielen met een overeenkomend host veld in uw .databrickscfg bestand bestaan, moet u de profile toewijzing (of de --profile-p opdrachtregelopties) gebruiken om een profiel op te geven. Toegevoegd in Databricks CLI versie 0.229.0
profile	Snaar	De naam van het Databricks-werkruimteprofiel. Zie workspace.profile. Toegevoegd in Databricks CLI versie 0.229.0
resource_path	Snaar	Het resourcepad voor de werkruimte Toegevoegd in Databricks CLI versie 0.230.0
root_path	Snaar	Het hoofdpad van de Databricks-werkruimte. Zie workspace.root_path. Toegevoegd in Databricks CLI versie 0.229.0
state_path	Snaar	Het pad naar de werkruimtestatus. Deze sleutel is standaard ingesteld op het standaardpad van ${workspace.root}/state en vertegenwoordigt het pad in uw werkruimte om terraform-statusinformatie over implementaties op te slaan. Toegevoegd in Databricks CLI versie 0.229.0

werkruimteverificatie

De werkruimtetoewijzing kan ook toewijzingen bevatten om het Databricks-verificatiemechanisme op te geven dat moet worden gebruikt. Als ze niet zijn opgegeven binnen de toewijzing van werkruimten op het hoogste niveau, moeten ze worden opgegeven in een werkruimtetoewijzing als onderliggend element van een of meer van de doelen in de toewijzing van doelen op het hoogste niveau.

• Voor OAuth machine-to-machine (M2M)-verificatie wordt de toewijzing client_id gebruikt. U kunt deze waarde ook instellen in de lokale omgevingsvariabele DATABRICKS_CLIENT_ID. U kunt ook een configuratieprofiel maken met de client_id waarde en vervolgens de naam van het profiel opgeven met de profile toewijzing (of door de --profile of -p opties te gebruiken bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI). Zie Toegang tot de service-principal autoriseren voor Azure Databricks met OAuth.

  Opmerking

  U kunt geen Azure Databricks OAuth-geheime waarde opgeven in het configuratiebestand voor bundels. Stel in plaats daarvan de lokale omgevingsvariabele DATABRICKS_CLIENT_SECRETin. U kunt ook de client_secret waarde toevoegen aan een configuratieprofiel en vervolgens de naam van het profiel opgeven met de profile toewijzing (of met behulp van de --profile of -p opties bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI).

• Voor Azure CLI-authenticatie wordt de toewijzing azure_workspace_resource_id gebruikt. U kunt deze waarde ook instellen in de lokale omgevingsvariabele DATABRICKS_AZURE_RESOURCE_ID. U kunt ook een configuratieprofiel maken met de azure_workspace_resource_id waarde en vervolgens de naam van het profiel opgeven met de profile toewijzing (of door de --profile of -p opties te gebruiken bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI). Zie Verifiëren met de Azure CLI.

• Voor Azure-clientgeheimverificatie met service-principals worden de toewijzingen azure_workspace_resource_id, azure_tenant_id en azure_client_id gebruikt. U kunt deze waarden ook instellen in de lokale omgevingsvariabelen DATABRICKS_AZURE_RESOURCE_IDen ARM_TENANT_IDARM_CLIENT_IDrespectievelijk. U kunt ook een configuratieprofiel maken met de azure_workspace_resource_id, azure_tenant_id, en azure_client_id waarden en vervolgens de naam van het profiel opgeven met de toewijzing van profile (of door de --profile of -p opties te gebruiken bij het uitvoeren van de bundel valideren, implementeren, uitvoeren en vernietigen opdrachten met de Databricks CLI). Zie Authenticeren met Microsoft Entra service principals.

  Opmerking

  U kunt geen azure-clientgeheimwaarde opgeven in het configuratiebestand van de bundel. Stel in plaats daarvan de lokale omgevingsvariabele ARM_CLIENT_SECRETin. U kunt ook de azure_client_secret waarde toevoegen aan een configuratieprofiel en vervolgens de naam van het profiel opgeven met de profile toewijzing (of met behulp van de --profile of -p opties bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI).

• Voor de verificatie van door Azure beheerde identiteiten worden de toewijzingen azure_use_msi, azure_client_id en azure_workspace_resource_id gebruikt. U kunt deze waarden ook instellen in de lokale omgevingsvariabelen ARM_USE_MSIen ARM_CLIENT_IDDATABRICKS_AZURE_RESOURCE_IDrespectievelijk. U kunt ook een configuratieprofiel maken met de azure_use_msi, azure_client_id, en azure_workspace_resource_id waarden en vervolgens de naam van het profiel opgeven met de toewijzing van profile (of door de --profile of -p opties te gebruiken bij het uitvoeren van de bundel valideren, implementeren, uitvoeren en vernietigen opdrachten met de Databricks CLI). Zie Verifiëren met door Azure beheerde identiteiten.

• Met de azure_environment toewijzing wordt het Azure-omgevingstype (zoals Public, UsGov, China en Duitsland) opgegeven voor een specifieke set API-eindpunten. De standaardwaarde is PUBLIC. U kunt deze waarde ook instellen in de lokale omgevingsvariabele ARM_ENVIRONMENT. U kunt ook de azure_environment waarde toevoegen aan een configuratieprofiel en vervolgens de naam van het profiel opgeven met de profile toewijzing (of met behulp van de --profile of -p opties bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI).

• De azure_login_app_id mapping is niet operationeel en is gereserveerd voor intern gebruik.

workspace.root_path

Deze workspace toewijzing kan een root_path toewijzing bevatten om een niet-standaardhoofdpad op te geven dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen, bijvoorbeeld:

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

Standaard gebruikt de Databricks CLI root_path het standaardpad van /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/${bundle.target}, waarbij vervangingen worden toegepast.

workspace.artifact_path

Deze workspace toewijzing kan ook een artifact_path toewijzing bevatten om een niet-standaardartefactpad op te geven dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen, bijvoorbeeld:

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

Standaard gebruikt de Databricks CLI artifact_path het standaardpad van ${workspace.root}/artifacts, waarbij vervangingen worden toegepast.

Opmerking

De artifact_path toewijzing biedt geen ondersteuning voor DBFS-paden (Databricks File System).

workspace.file_path

Deze workspace toewijzing kan ook een file_path toewijzing bevatten om een niet-standaardbestandspad op te geven dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen, bijvoorbeeld:

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

Standaard gebruikt de Databricks CLI file_path het standaardpad van ${workspace.root}/files, waarbij vervangingen worden toegepast.

Belangrijk

U kunt geen aangepaste variabelen opgeven voor deze verificatiewaarden met behulp van de ${var.*} syntaxis.

workspace.profile

Opmerking

Databricks raadt u aan de host toewijzing te gebruiken (of de --profile of -p opties bij het uitvoeren van de bundelvalidatie, implementeren, uitvoeren en vernietigen van opdrachten met de Databricks CLI) in plaats van de profile toewijzing, omdat uw bundelconfiguratiebestanden hierdoor draagbaarder worden.

De profile toewijzing geeft de naam op van een configuratieprofiel dat moet worden gebruikt voor verificatie bij deze Azure Databricks-werkruimte. Dit configuratieprofiel wordt toegewezen aan het profiel dat u hebt gemaakt bij het instellen van de Databricks CLI.

Algemene objecten

Git

Type: Map

Definieert details van git-versiebeheer. Dit is handig voor het doorgeven van metagegevens van implementaties die later kunnen worden gebruikt om resources te identificeren. U kunt bijvoorbeeld de oorsprong van de opslagplaats van een taak traceren die is geïmplementeerd door CI/CD.

Wanneer u een bundle opdracht uitvoert, zoals validate, deploy of run, wordt de bundle configuratiestructuur van de opdracht gevuld met de volgende standaardinstellingen:

Als u Git-instellingen wilt ophalen of overschrijven, moet uw bundel zich in een map bevinden die is gekoppeld aan een Git-opslagplaats, bijvoorbeeld een lokale map die wordt geïnitialiseerd door de opdracht uit te git clone voeren. Als de map niet is gekoppeld aan een Git-opslagplaats, zijn deze Git-instellingen leeg.

Sleutel	Typologie	Beschrijving
branch	Snaar	De naam van de huidige Git-vertakking. Dit is dezelfde waarde die u zou krijgen als u de opdracht git branch --show-current uit uw gekloonde opslagplaats hebt uitgevoerd. U kunt vervangingen gebruiken om naar deze waarde te verwijzen met uw bundelconfiguratiebestanden, zoals ${bundle.git.branch}.
origin_url	Snaar	De oorspronkelijke URL van de opslagplaats. Dit is dezelfde waarde die u zou krijgen als u de opdracht git config --get remote.origin.url uit uw gekloonde opslagplaats hebt uitgevoerd. U kunt vervangingen gebruiken om naar deze waarde te verwijzen met uw bundelconfiguratiebestanden, zoals ${bundle.git.origin_url}.

Voorbeelden

U kunt indien nodig de origin_url en branch instellingen in de git toewijzing van uw toewijzing op het hoogste niveau bundle overschrijven:

bundle:
  git:
    origin_url: <some-non-default-origin-url>
    branch: <some-non-current-branch-name>