Informazioni di riferimento sulla configurazione

Questo articolo fornisce informazioni di riferimento sulle chiavi supportate dalla configurazione dei bundle di asset di Databricks (YAML). Consulta Che cosa sono i Databricks asset bundle?.

Per esempi completi di bundle, vedere gli esempi di configurazione del bundle e il repository GitHub bundle-examples.

artefatto

Definisce le impostazioni per costruire un artefatto.

Chiave	Digitare	Descrizione
build	Stringa	Set facoltativo di comandi di compilazione da eseguire localmente prima della distribuzione.
executable	Stringa	Tipo eseguibile. I valori validi sono bash, she cmd.
files	Mappa	Il percorso relativo o assoluto ai file del artefatto compilato, definito come artifact_file.
path	Stringa	Percorso locale della directory per l'artefatto.
type	Stringa	Obbligatorio se l'artefatto è una rotellina Python. Tipo dell'artefatto. I valori validi sono whl e jar.

Artefatti

Definisce gli attributi per creare gli artefatti, dove ogni chiave è il nome dell'artefatto e il valore è una mappa che definisce le impostazioni di creazione dell'artefatto . Per informazioni sulla mappatura dei artifacts, consultare gli artefatti .

Le impostazioni degli artefatti definite nel livello principale della configurazione del bundle possono essere sovrascritte nella mappatura targets. Consulta Definire le impostazioni degli artefatti nei Bundle di Asset di Databricks.

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

Esempio

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

artifact_file

Definisce un file di artefatto in un bundle.

Chiave	Digitare	Descrizione
source	Stringa	Obbligatorio. File di origine dell'artefatto.

pacchetto

Attributi del bundle. Vedi il pacchetto .

Chiave	Digitare	Descrizione
cluster_id	Stringa	ID di un cluster da usare per eseguire il bundle. Vedere cluster_id.
databricks_cli_version	Stringa	Versione della CLI (interfaccia della riga di comando) di Databricks da utilizzare con il bundle. Vedere databricks_cli_version.
deployment	Mappa	Definizione della distribuzione del bundle. Per gli attributi supportati, vedere distribuzione e modalità di distribuzione del pacchetto di asset di Databricks.
git	Mappa	Dettagli del controllo della versione Git associati al bundle. Per gli attributi supportati, vedere git e git.
name	Stringa	Obbligatorio. Nome del pacchetto.
uuid	Stringa	Riservato. Identificatore Univoco Universale (UUID) per il bundle che lo identifica in modo univoco all'interno dei sistemi interni di Databricks. Questo viene generato quando un progetto bundle viene inizializzato usando un modello di Databricks (usando il comando databricks bundle init).

distribuzione

Definisce gli attributi di distribuzione del pacchetto.

Chiave	Digitare	Descrizione
fail_on_active_runs	Booleano	Indica se l'esecuzione attiva ha esito negativo. Se questa opzione è impostata su true una distribuzione in esecuzione può essere interrotta.
lock	Mappa	Attributi di blocco della distribuzione. Consultare blocco .

sperimentale

Definisce gli attributi per le funzionalità sperimentali.

Chiave	Digitare	Descrizione
python_wheel_wrapper	Booleano	Se utilizzare un pacchetto wheel di Python.
scripts	Comando (stringa)	Comandi da eseguire
use_legacy_run_as	Booleano	Indica se usare il comportamento di run_as legacy.

Git

Definisce i dettagli del controllo della versione Git associati al bundle. Vedere git.

Chiave	Digitare	Descrizione
origin_url	Stringa	L'URL di origine del repository. Vedere git.
branch	Stringa	Nome del ramo Git. Vedere git.

concedere

Definisce l'accesso agli oggetti del catalogo Unity. Per ulteriori informazioni, vedere Connect to cloud object storage and services using Unity Catalog.

Chiave	Digitare	Descrizione
principal	Stringa	Obbligatorio. Nome dell'entità a cui verranno concessi privilegi.
privileges	Stringa	Obbligatorio. Privilegi da concedere all'entità specificata.

Esempio

L'esempio seguente definisce uno schema del catalogo Unity con concessioni:

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

serratura

Definisce gli attributi di blocco della distribuzione del bundle.

Chiave	Digitare	Descrizione
enabled	Booleano	Indica se questo blocco è abilitato.
force	Booleano	Indica se forzare questo blocco se è abilitato.

permesso

Definisce un'autorizzazione per un'entità specifica. Vedi le autorizzazioni e Imposta le autorizzazioni per le risorse nei Databricks Asset Bundles.

Chiave	Digitare	Descrizione
group_name	Stringa	Il nome del gruppo che ha il set di autorizzazioni in level.
level	Stringa	Obbligatorio. Autorizzazioni consentite per utente, gruppo, principale del servizio definite per questo permesso.
service_principal_name	Stringa	Il nome del principale del servizio che ha i permessi impostati in level.
user_name	Stringa	Nome dell'utente con il set di autorizzazioni in level.

Autorizzazioni

Sequenza che definisce le autorizzazioni da applicare a esperimenti, processi, pipeline e modelli definiti nel bundle, in cui ogni elemento della sequenza è un 'autorizzazione per un'entità specifica.

Vedi le autorizzazioni e Imposta le autorizzazioni per le risorse nei Databricks Asset Bundles.

Esempio

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

Preimpostazioni

Definisce le preimpostazioni di distribuzione del bundle. Vedere impostazioni predefinite personalizzate.

Chiave	Digitare	Descrizione
jobs_max_concurrent_runs	Numero intero	Numero massimo di esecuzioni simultanee per un processo.
name_prefix	Stringa	Prefisso per le esecuzioni del processo del bundle.
pipelines_development	Booleano	Indica se le distribuzioni della pipeline devono essere bloccate in modalità di sviluppo.
source_linked_deployment	Booleano	Se collegare o meno la distribuzione alla fonte del bundle.
tags	Mappa	Tag per la distribuzione del bundle.
trigger_pause_status	Stringa	Stato di sospensione da applicare a tutti i trigger e le pianificazioni dei lavori. I valori validi sono PAUSED o UNPAUSED.

risorse

Mappa che definisce le risorse per il bundle, dove ogni chiave è il nome della risorsa e il valore è una mappa che definisce la risorsa. Per ulteriori informazioni sulle risorse supportate dai bundle di asset di Databricks e sulla documentazione di riferimento per le definizioni delle risorse, vedere risorse dei bundle di asset di Databricks.

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

Chiave	Digitare	Descrizione
clusters	Mappa	Definizioni di cluster per il bundle, in cui ogni chiave è il nome di un cluster. Osservare il gruppo cluster
dashboards	Mappa	Le definizioni delle dashboard per il bundle, dove ogni chiave è il nome della dashboard. Visualizza dashboard
experiments	Mappa	Definizioni dell'esperimento per il bundle, in cui ogni chiave è il nome dell'esperimento. Vedi esperimento
jobs	Mappa	Definizioni di attività per il bundle, in cui ogni chiave è il nome dell'attività. Vedi lavoro
model_serving_endpoints	Mappa	Le definizioni degli endpoint di servizio dei modelli per il pacchetto, dove ogni chiave è il nome dell'endpoint di servizio del modello. Vedere model_serving_endpoint
models	Mappa	Definizioni di modello per il bundle, in cui ogni chiave è il nome del modello. Consulta il modello (legacy)
pipelines	Mappa	Le definizioni di pipeline per il bundle, dove ogni chiave è il nome della pipeline. Consulta la pipeline
quality_monitors	Mappa	Definizioni di monitoraggio qualità per il bundle, in cui ogni chiave è il nome del monitoraggio qualità. Vedere quality_monitor (Unity Catalog)
registered_models	Mappa	Le definizioni di modello registrate per il bundle, dove ogni chiave è il nome di un modello registrato nel Unity Catalog. Consultare registered_model (catalogo Unity)
schemas	Mappa	Definizioni dello schema per il bundle, in cui ogni chiave è il nome dello schema. Vedere schema (Unity Catalog)
volumes	Mappa	Le definizioni dei volumi per il bundle, dove ogni chiave è il nome del volume. Consultare il volume (Catalogo Unity)

run_as

Identità da utilizzare durante l'esecuzione dei workflow dei pacchetti di asset di Databricks. Consultare Specificare un'identità di esecuzione per un flusso di lavoro dei pacchetti di asset di Databricks.

Chiave	Digitare	Descrizione
service_principal_name	Stringa	ID applicazione di un'entità servizio attiva. L'impostazione di questo campo richiede il ruolo servicePrincipal/user.
user_name	Stringa	L'email di un utente attivo dell'area di lavoro. Gli utenti non amministratori possono impostare questo campo solo sul proprio messaggio di posta elettronica.

Sincronizzazione

File e percorsi di file da includere o escludere nel bundle. Vedere sync.

Chiave	Digitare	Descrizione
exclude	Sequenza	Elenco di file o cartelle da escludere dal bundle.
include	Sequenza	Elenco di file o cartelle da includere nel bundle.
paths	Sequenza	I percorsi delle cartelle locali, che possono essere esterni alla radice del bundle, per eseguire la sincronizzazione con l'area di lavoro quando viene distribuito il bundle.

bersaglio

Definisce le destinazioni di distribuzione per il bundle. Vedi obiettivi

Chiave	Digitare	Descrizione
artifacts	Mappa	I componenti da includere nella distribuzione finale. Vedere artefatti.
bundle	Mappa	Attributi del bundle per la distribuzione su questo target.
cluster_id	Stringa	ID del cluster da usare per questa destinazione.
compute_id	Stringa	Deprecato. L'ID del calcolatore da usare per questa destinazione.
default	Booleano	Indica se questa destinazione è la destinazione predefinita.
git	Mappa	Impostazioni del controllo della versione Git per l'obiettivo. Vedere git.
mode	Stringa	Modalità di distribuzione per la destinazione. I valori validi sono development o production. Per ulteriori informazioni, vedi le modalità di distribuzione del bundle di asset di Databricks .
permissions	Sequenza	Autorizzazioni per la distribuzione e l'esecuzione del bundle nell'ambiente di destinazione. Consulta autorizzazioni.
presets	Mappa	Impostazioni predefinite di distribuzione per destinazione. Vedi impostazioni predefinite.
resources	Mappa	Definizioni di risorse per la destinazione. Vedi le risorse .
run_as	Mappa	Identità da usare per eseguire il bundle. Vedere run_as e Specificare un'identità di esecuzione per un flusso di lavoro dei bundle di asset di Databricks.
sync	Mappa	I percorsi locali da sincronizzare con l'area di lavoro di destinazione quando un bundle viene eseguito o distribuito. Vedere sync.
variables	Mappa	Definizioni di variabili personalizzate per la destinazione. Vedere variabili e sostituzioni e variabili in Aggregazioni di asset di Databricks.
workspace	Mappa	Area di lavoro di Databricks per l'obiettivo. #area di lavoro

Variabili

Mappa che definisce le variabili personalizzate per il bundle, dove ogni chiave è il nome della variabile e il valore è una mappa che definisce la variabile. Vedi sostituzioni e variabili nei Bundle di asset di Databricks.

Chiave	Digitare	Descrizione
nome variabile	Mappa	Definizione di una variabile. Vedi nome variabile.

nome variabile

Ogni definizione di variabile ha gli attributi seguenti:

Chiave	Digitare	Descrizione
description	Stringa	Descrizione della variabile.
lookup	Stringa	Nome del alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalo warehouse oggetto per cui recuperare un ID.
type	Stringa	Tipo della variabile. I valori validi sono complex.

Spazio di lavoro

Definisce l'area di lavoro di Databricks per il bundle. Vedi l'area di lavoro .

Chiave	Digitare	Descrizione
artifact_path	Stringa	Percorso dell'artefatto da usare all'interno dell'area di lavoro sia per la distribuzione che per l'esecuzione del flusso di lavoro
auth_type	Stringa	Tipo di autenticazione.
azure_client_id	Stringa	ID client di Azure.
azure_environment	Stringa	Ambiente Azure.
azure_login_app_id	Stringa	ID app di accesso di Azure.
azure_tenant_id	Stringa	ID tenant di Azure.
azure_use_msi	Booleano	Se utilizzare MSI per Azure.
azure_workspace_resource_id	Stringa	ID della risorsa dell'area di lavoro di Azure.
client_id	Stringa	ID cliente per l'area di lavoro.
file_path	Stringa	Il percorso del file da utilizzare all'interno dell'area di lavoro sia per le implementazioni che per le esecuzioni dei flussi di lavoro.
google_service_account	Stringa	Nome dell'account del servizio Google.
host	Stringa	L'URL host dell'area di lavoro Databricks.
profile	Stringa	Nome del profilo dell'area di lavoro di Databricks.
resource_path	Stringa	Percorso della risorsa dell'area di lavoro.
root_path	Stringa	Percorso radice dell'area di lavoro di Databricks.
state_path	Stringa	Percorso dello stato dell'area di lavoro.