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

Definieert de kenmerken voor het bouwen van artefacten, waarbij elke sleutel de naam van het artefact is en de waarde een kaart is waarmee de build-instellingen voor artefacten worden gedefinieerd. Voor informatie over de artifacts-toewijzing, zie de -artefacten.

Artefactinstellingen die zijn gedefinieerd op het hoogste niveau van de bundelconfiguratie, kunnen worden overschreven in de targets mapping. Zie Overschrijven met doelinstellingen.

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.
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. Zie artefacten.
executable	Snaar	Het uitvoerbare type. Geldige waarden zijn bash, shen cmd.
files	Volgorde	Het relatieve of absolute pad naar de gebouwde artefact bestanden. Zie artefacten.name.files.
path	Snaar	Het lokale pad van de map voor het artefact.
type	Snaar	Vereist als het artefact een Python-wiel is. Het type artefact. Geldige waarden zijn whl en jar.

Voorbeeld

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

Artefacten.naam.bestanden

Type: Sequence

Het relatieve of absolute pad naar de gebouwde artefact bestanden.

Sleutel	Typologie	Beschrijving
source	Snaar	Vereist. Het artefact-bronbestand.

bundel

Type: Map

De bundelkenmerken voor implementatie naar deze doelomgeving.

Sleutel	Typologie	Beschrijving
cluster_id	Snaar	De id van een cluster dat moet worden gebruikt om de bundel uit te voeren. Zie cluster_id.
compute_id	Snaar	Verouderd. De ID van het computing systeem dat moet worden gebruikt om de bundel uit te voeren.
databricks_cli_version	Snaar	De Databricks CLI-versie die moet worden gebruikt voor de bundel. Zie databricks_cli_version.
deployment	Kaart	De definitie van de bundelimplementatie. Zie de implementatiemodi databricks Asset Bundle voor ondersteunde kenmerken. Zie bundle.deployment.
git	Kaart	De details van het Git-versiebeheer die aan uw bundel zijn gekoppeld. Zie Git voor ondersteunde kenmerken. Zie git.
name	Snaar	De naam van de bundel.
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).

bundel.implementatie

Type: Map

De definitie van de bundelimplementatie

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.
lock	Kaart	De inzetvergrendelingsattributen. Zie bundle.deployment.lock.

bundle.implementatie.vergrendeling

Type: Map

De inzetvergrendelingsattributen.

Sleutel	Typologie	Beschrijving
enabled	Booleaans	Of deze vergrendeling is ingeschakeld.
force	Booleaans	Of deze vergrendeling moet worden afgedwongen als deze is ingeschakeld.

experimenteel

Type: Map

Definieert kenmerken voor experimentele functies.

Sleutel	Typologie	Beschrijving
python	Kaart	Verouderd. Gebruik de python-mapping op het hoogste niveau in plaats daarvan.
python_wheel_wrapper	Booleaans	Of u een Python wiel-wrapper wilt gebruiken.
scripts	Kaart	De opdrachten die moeten worden uitgevoerd.
use_legacy_run_as	Booleaans	Of u het oudere run_as gedrag wilt gebruiken.

opnemen

Type: Sequence

Hiermee geeft u een lijst met pad globs die configuratiebestanden bevatten die in de bundel moeten worden opgenomen. Zie include.

Machtigingen

Type: Sequence

Een reeks die de machtigingen definieert die moeten worden toegepast op resources die in de bundel zijn gedefinieerd, waarbij elk item in de reeks een machtiging is voor een specifieke entiteit.

Zie machtigingen en Machtigingen instellen voor resources in Databricks Asset Bundles.

Sleutel	Typologie	Beschrijving
group_name	Snaar	De naam van de groep waarvoor de machtigingen per niveau zijn ingesteld.
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.
service_principal_name	Snaar	De naam van de service-principal met de machtigingen die op niveau zijn ingesteld.
user_name	Snaar	De naam van de gebruiker die de machtiging op een bepaald niveau heeft ingesteld.

Voorbeeld

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.

Sleutel	Typologie	Beschrijving
jobs_max_concurrent_runs	Geheel getal	De maximale gelijktijdige uitvoeringen voor een taak.
name_prefix	Snaar	Het voorvoegsel voor taakuitvoeringen van de bundel.
pipelines_development	Booleaans	Of pijplijnimplementaties moeten worden vergrendeld in de ontwikkelingsmodus.
source_linked_deployment	Booleaans	Of de implementatie moet worden gekoppeld aan de bundelbron.
tags	Kaart	De tags voor de bundelimplementatie.
trigger_pause_status	Snaar	Een onderbrekingsstatus die moet worden toegepast op alle taaktriggers en -planningen. Geldige waarden zijn ONDERBROKEN of NIET ONDERBROKEN.

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.

Sleutel	Typologie	Beschrijving
mutators	Volgorde	Mutators bevatten een lijst met volledig gekwalificeerde functiepaden voor mutatorfuncties, zoals [my_project.mutators:add_default_cluster].
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"]
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.

middelen

Type: Map

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

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.
apps	Kaart	De Databricks-app-definities voor de bundel, waarbij elke sleutel de naam van de app is. Bekijk de app.
clusters	Kaart	De clusterdefinities voor de bundel, waarbij elke sleutel de naam van een cluster is. Zie cluster.
dashboards	Kaart	De dashboarddefinities voor de bundel, waarbij elke sleutel de naam van het dashboard is. Zie dashboard.
database_catalogs	Kaart	De databasecatalogusdefinities voor de bundel, waarbij elke sleutel de naam van de databasecatalogus is. Zie database_catalog.
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.
experiments	Kaart	De experimentdefinities voor de bundel, waarbij elke sleutel de naam van het experiment is. Zie experiment.
jobs	Kaart	De taakdefinities voor de bundel, waarbij elke sleutel de naam van de taak is. Zie de taak.
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.
models	Kaart	De modeldefinities voor de bundel, waarbij elke sleutel de naam van het model is. Zie model (verouderd).
pipelines	Kaart	De pijplijndefinities voor de bundel, waarbij elke sleutel de naam van de pijplijn is. Zie de pijplijn.
quality_monitors	Kaart	De kwaliteitsmonitordefinities voor de bundel, waarbij elke sleutel de naam is van de kwaliteitsmonitor. Zie quality_monitor (Unity Catalog).
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).
schemas	Kaart	De schemadefinities voor de bundel, waarbij elke sleutel de naam van het schema is. Zie schema (Unity Catalog).
secret_scopes	Kaart	De geheime bereikdefinities voor de bundel, waarbij elke sleutel de naam is van het geheime bereik. Zie secret_scope.
sql_warehouses	Kaart	De SQL Warehouse-definities voor de bundel, waarbij elke sleutel de naam van het SQL Warehouse is. Zie sql_warehouse.
synced_database_tables	Kaart	De gesynchroniseerde databasetabeldefinities voor de bundel, waarbij elke sleutel de naam van de databasetabel is. Zie synced_database_table.
volumes	Kaart	De volumedefinities voor de bundel, waarbij elke sleutel de naam van het volume is. Zie volume (Unity Catalog).

uitvoeren als

Type: Map

De identiteit die moet worden gebruikt bij het uitvoeren van Databricks Asset Bundles-werkstromen. Zie Een uitvoeringsidentiteit opgeven voor een Databricks Asset Bundles-werkstroom.

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.
user_name	Snaar	Het e-mailadres van een actieve werkruimtegebruiker. Niet-beheerders kunnen dit veld alleen instellen op hun eigen e-mail.

Scripts

Type: Map

De scripts die kunnen worden uitgevoerd met behulp van bundle run. Zie Scripts uitvoeren.

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

Sleutel	Typologie	Beschrijving
content	Snaar	De opdrachten die moeten worden uitgevoerd

synchroniseren

Type: Map

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

Sleutel	Typologie	Beschrijving
exclude	Volgorde	Een lijst met bestanden of mappen die moeten worden uitgesloten van de bundel.
include	Volgorde	Een lijst met bestanden of mappen die moeten worden opgenomen in de bundel.
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.

Doelstellingen

Type: Map

Definieert implementatiedoelen voor de bundel. Zie doelen

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.
bundle	Kaart	De bundelkenmerken voor implementatie naar deze doelomgeving. Zie bundel.
cluster_id	Snaar	De id van het cluster dat voor dit doel moet worden gebruikt.
compute_id	Snaar	Verouderd. De ID van de computereenheid die voor dit doel moet worden gebruikt.
default	Booleaans	Of dit doel het standaarddoel is.
git	Kaart	De instellingen voor Git-versiebeheer voor het doel. Zie git.
mode	Snaar	De implementatiemodus voor het doel. Geldige waarden zijn development of production. Zie implementatiemodi voor Databricks Asset Bundle.
permissions	Volgorde	De machtigingen voor het implementeren en uitvoeren van de bundel in het doelsysteem. Zie machtigingen.
presets	Kaart	De voorinstellingen voor implementatie voor het doelwit. Zie de voorinstellingen.
resources	Kaart	De hulpmiddeldefinities voor het beoogde doel. Zie de resources.
run_as	Kaart	De identiteit die moet worden gebruikt om de bundel uit te voeren, zie Een uitvoeringsidentiteit opgeven voor een Databricks Asset Bundles-werkstroom. Zie run_as.
sync	Kaart	De lokale paden voor synchronisatie met de doelwerkruimte wanneer een bundel wordt uitgevoerd of geïmplementeerd. Zie synchronisatie.
variables	Kaart	De aangepaste variabeledefinities voor het doel. Zie variabelen.
workspace	Kaart	De Databricks-werkruimte voor de beoogde doelstelling. Zie werkruimte.

Variabelen

Type: Map

Hiermee definieert u een aangepaste variabele voor de bundel. Zie variabelen.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

Sleutel	Typologie	Beschrijving
default	Welke dan ook	De standaardwaarde voor de variabele.
description	Snaar	De beschrijving van de variabele.
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.
type	Snaar	Het type variabele, eenvoudig of complex. Stel deze sleutel alleen in als de variabele complex is. Geldige waarden: complex.

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.

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

Werkruimte

Type: Map

Hiermee definieert u de Databricks-werkruimte voor de bundel. Zie werkruimte.

Sleutel	Typologie	Beschrijving
artifact_path	Snaar	Het artefactpad dat in de werkruimte gebruikt wordt voor zowel implementaties als werkstroomruns
auth_type	Snaar	Het verificatietype.
azure_client_id	Snaar	De Azure-client-ID
azure_environment	Snaar	De Azure-omgeving
azure_login_app_id	Snaar	De id van de Azure-aanmeldings-app
azure_tenant_id	Snaar	Het Azure tenant-ID
azure_use_msi	Booleaans	Of u MSI wilt gebruiken voor Azure
azure_workspace_resource_id	Snaar	De resource-id van de Azure-werkruimte
client_id	Snaar	De client-id voor de werkruimte
file_path	Snaar	Het bestandspad dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen
google_service_account	Snaar	De naam van het Google-serviceaccount
host	Snaar	De HOST-URL van de Databricks-werkruimte
profile	Snaar	De naam van het Databricks-werkruimteprofiel
resource_path	Snaar	Het resourcepad voor de werkruimte
root_path	Snaar	Het hoofdpad van de Databricks-werkruimte
state_path	Snaar	Het pad naar de status van de werkruimte

Algemene objecten

Git

Type: Map

Definieert details van git-versiebeheer.

Sleutel	Typologie	Beschrijving
branch	Snaar	De naam van de Git-vertakking. Zie git.
origin_url	Snaar	De oorspronkelijke URL van de opslagplaats. Zie git.