Databricks CLI-opdrachten

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger. De Databricks CLI bevindt zich in openbare preview.

Databricks CLI-gebruik is onderhevig aan de Databricks-licentie en de privacyverklaring van Databricks, met inbegrip van alle bepalingen voor gebruiksgegevens.

Dit artikel bevat informatie over beschikbare Databricks CLI-opdrachten. Deze informatie vormt een aanvulling op de help voor de opdrachtregel. Zie De Databricks CLI installeren of bijwerken en wat is de Databricks CLI? voor meer informatie over het installeren en gebruiken van de Databricks CLI.

De Databricks CLI bevat de opdrachtgroepen die worden vermeld in de volgende tabellen. Opdrachtgroepen bevatten sets met gerelateerde opdrachten, die ook subopdrachten kunnen bevatten. Gebruiks- en syntaxisgegevens voor een opdrachtgroep, een afzonderlijke opdracht of subopdracht uitvoeren:

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

Veel CLI-opdrachten worden toegewezen aan bewerkingen die worden beschreven in de Naslaginformatie over de Azure Databricks REST API.

Werkruimteopdrachten

Groep	Beschrijving en opdrachten
Fs	Opdrachten voor het beheren van bestanden en het bestandssysteem: catls, cp, mkdirrm
git-credentials	Opdrachten voor het registreren van persoonlijke toegangstokens voor Databricks om bewerkingen uit te voeren namens de gebruiker: createget, delete, listupdate
repos	Opdrachten waarmee gebruikers hun Git-opslagplaatsen kunnen beheren: createget, delete, listupdate get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
secrets	Opdrachten voor het beheren van geheimen, geheime bereiken en toegangsmachtigingen: create-scope, , delete-acldelete-scope, delete-secret, get-acl, , get-secret, , list-secretslist-scopesput-acllist-aclsput-secret
workspace	Opdrachten voor het weergeven, importeren, exporteren en verwijderen van notitieblokken en mappen in de werkruimte: delete, , exportexport-dir, get-status, , import, , import-dirlistmkdirs get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Compute-opdrachten

Groep	Beschrijving en opdrachten
cluster-policies	Opdrachten voor het beheren van de mogelijkheid van gebruikers om clusters te configureren op basis van een set regels: createedit, delete, getlist get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
clusters	Opdrachten waarmee u clusters kunt maken, starten, bewerken, weergeven, beëindigen en verwijderen: change-owner, , delete, , , events, , get, listlist-node-types, ,pinrestartlist-zonesstartpermanent-deletespark-versionsresizeeditcreateunpin get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
global-init-scripts	Opdrachten waarmee werkruimtebeheerders globale initialisatiescripts voor hun werkruimte kunnen configureren: createget, delete, listupdate
instance-pools	Opdrachten voor het maken, bewerken, verwijderen en vermelden van exemplaargroepen met kant-en-klare cloudexemplaren, waardoor het starten en automatisch schalen van een cluster wordt verminderd: createedit, delete, getlist get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
instance-profiles	Opdrachten waarmee beheerders exemplaarprofielen kunnen toevoegen, weergeven en verwijderen waarmee gebruikers clusters kunnen starten met: add, , , editlistremove
libraries	Opdrachten voor het installeren, verwijderen en ophalen van de status van bibliotheken in een cluster: all-cluster-statuses, , , cluster-statusinstalluninstall
policy-families	Opdrachten voor het weergeven van beschikbare beleidsfamilies: get, list

Opdrachten voor taken

Groep	Beschrijving en opdrachten
jobs	Opdrachten voor het beheren van taken: cancel-all-runs, , create, , , delete-run, , , get-run-outputget-runrun-nowlist-runsrepair-runsubmitresetlistgetexport-rundeletecancel-runupdate get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Delta Live Tables-opdrachten

Groep	Beschrijving en opdrachten
pipelines	Opdrachten voor het maken, bewerken, verwijderen, starten en weergeven van details over pijplijnen: create, , get, get-updatedelete, , list-pipeline-events, list-pipelines, , stopstart-updatelist-updatesupdate get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Machine Learning-opdrachten

Groep	Beschrijving en opdrachten
experiments	Opdrachten voor interactie met experimenten, die de primaire eenheid van de organisatie in MLflow zijn; alle MLflow-uitvoeringen horen bij een experiment: create-experiment, , delete-experiment, , , delete-runs, , delete-tag, , get-runGetsearch-runslog-batchlog-inputslist-experimentsget-historyset-tagrestore-runset-experiment-taglog-modellog-paramrestore-experimentsearch-experimentsupdate-experimentlist-artifactsrestore-runsget-experimentlog-metricget-by-namedelete-runcreate-runupdate-run get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
model-registry	Opdrachten voor het werkruimtemodelregister: approve-transition-request, , create-model, , , , create-webhook, , , delete-model-versionupdate-commentget-model-version-download-uriget-model-versionlist-modelsget-modelget-latest-versionsdelete-webhooklist-transition-requestsdelete-transition-requestdelete-model-version-tagdelete-model-tagdelete-modelupdate-modelsearch-model-versionssearch-modelsset-model-tagrename-modeltest-registry-webhookupdate-model-versionset-model-version-taglist-webhooksreject-transition-requesttransition-stagedelete-commentcreate-transition-requestcreate-model-versioncreate-commentupdate-webhook get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Opdrachten in realtime leveren

Groep	Beschrijving en opdrachten
serving-endpoints	Opdrachten voor het maken, bijwerken en verwijderen van model voor eindpunten: build-logs, , createdelete, export-metrics, get, , list, , putpatchquerylogsupdate-config get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Opdrachten voor identiteits- en toegangsbeheer

Groep	Beschrijving en opdrachten
account	Opdrachten voor het beheren van Databricks-accounts: - Identiteit en toegang: access-control, groups, service-principals, usersworkspace-assignment - Unity Catalog: metastore-assignments, metastoresstorage-credentials - Instellingen: ip-access-lists, network-connectivitysettings - Inrichting: credentials, , encryption-keysnetworks, private-access, , storage, vpc-endpointsworkspaces - Facturering: billable-usage, log-delivery - OAuth: custom-app-integration, o-auth-published-apps, published-app-integrationservice-principal-secrets
Auth	Opdrachten voor verificatie: describelogin, env, profilestoken
current-user	Opdrachten voor het ophalen van informatie over momenteel geverifieerde gebruikers of service-principals: me
groups	Opdrachten voor groepen die identiteitsbeheer vereenvoudigen, waardoor het eenvoudiger is om toegang toe te wijzen aan databricks-werkruimte, gegevens en andere beveiligbare objecten: create, , deleteget, list, , , patchupdate
permissions	Opdrachten voor het maken van lees-, schrijf-, bewerkings-, update- en beheertoegang voor verschillende gebruikers op verschillende objecten en eindpunten: get, , setupdate get-permission-levels
service-principals	Opdrachten voor identiteiten voor gebruik met taken, geautomatiseerde hulpprogramma's en systemen zoals scripts, apps en CI/CD-platforms: create, , deleteget, list, , , patchupdate
users	Opdrachten voor gebruikersidentiteiten die worden herkend door Databricks en vertegenwoordigd door e-mailadressen: create, , deleteget, list, , , patchupdate get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

SQL-gerelateerde opdrachten

Groep	Beschrijving en opdrachten
alerts	Opdrachten voor het uitvoeren van bewerkingen op waarschuwingen: createget, delete, listupdate
data-sources	Opdrachten voor het maken van nieuwe queryobjecten: list
queries	Opdrachten voor het uitvoeren van bewerkingen voor querydefinities: create, , deleteget, list, , , restoreupdate
query-history	Opdrachten voor toegang tot de geschiedenis van query's via SQL Warehouses: list
warehouses	Opdrachten voor het beheren van SQL-warehouses, een rekenresource waarmee u SQL-opdrachten kunt uitvoeren op gegevensobjecten in Databricks SQL: create, , editdelete, get, , get-workspace-warehouse-config, list, startset-workspace-warehouse-configstop get-permission-levels, , , get-permissionsset-permissionsupdate-permissions

Unity Catalog-opdrachten

Groep	Beschrijving en opdrachten
artifact-allowlists	Opdrachten voor het beheren van acceptatielijsten voor artefacten. In Databricks Runtime 13.3 en hoger kunt u bibliotheken en init-scripts toevoegen aan de acceptatielijst in UC, zodat gebruikers deze artefacten kunnen gebruiken voor berekening die is geconfigureerd met de modus voor gedeelde toegang: get, update
catalogs	Opdrachten voor het beheren van catalogi, de eerste laag van de naamruimte op drie niveaus van Unity Catalog: createget, delete, listupdate
connections	Opdrachten voor het maken van een verbinding met een externe gegevensbron: createget, delete, listupdate
external-locations	Opdrachten voor het beheren van externe locaties, waarbij een cloudopslagpad wordt gecombineerd met een opslagreferentie waarmee toegang tot het cloudopslagpad wordt toegestaan: createget, delete, listupdate
functions	Opdrachten voor het beheren van door de gebruiker gedefinieerde functies (UDF's) in de Unity-catalogus: createget, delete, listupdate
grants	Opdrachten voor het verlenen van toegang tot gegevens in Unity Catalog: get, , get-effectiveupdate
metastores	Opdrachten voor het beheren van metastores, de container op het hoogste niveau van objecten in Unity Catalog: assign, , current, deletecreate, , get, list, , updateunassignsummaryupdate-assignment
model-versions	Opdrachten voor het beheren van modelversies. Databricks biedt een gehoste versie van MLflow Model Registry in Unity Catalog. deleteget-by-alias, get, listupdate
online-tables	Opdrachten voor het beheren van onlinetabellen, die lagere latentie en hogere QPS-toegang bieden tot gegevens uit Delta-tabellen: create, , deleteget
quality-monitors	Opdrachten voor het beheren van monitors, waarmee metrische gegevens van gegevens of modelkwaliteit voor een tabel in de loop van de tijd worden berekend en bewaakt: create, , deleteget, get-refresh, , list-refreshes, , run-refreshupdate
registered-models	Opdrachten voor het beheren van geregistreerde modellen. Databricks biedt een gehoste versie van MLflow Model Registry in Unity Catalog. create, , deletedelete-alias, get, , list, , set-aliasupdate
schemas	Opdrachten voor het beheren van schema's, de tweede laag van de naamruimte op drie niveaus van Unity Catalog: createget, delete, listupdate
storage-credentials	Opdrachten voor het beheren van opslagreferenties, een verificatie- en autorisatiemechanisme voor toegang tot gegevens die zijn opgeslagen in uw cloudtenant: create, , deleteget, list, , , updatevalidate
system-schemas	Opdrachten voor het beheren van systeemschema's, schema's die zich in de systeemcatalogus bevinden: disable, , enablelist
table-constraints	Opdrachten voor het beheren van beperkingen voor primaire sleutels en refererende sleutels waarmee relaties tussen velden in tabellen worden gecodeerd: create, delete
tables	Opdrachten voor het beheren van tabellen, die zich in de derde laag van de naamruimte op drie niveaus van de Unity Catalog bevinden: deleteget, exists, listlist-summaries
volumes	Opdrachten voor het beheren van volumes, die een UC-mogelijkheid (Unity Catalog) zijn voor het openen, opslaan, beheren, ordenen en verwerken van bestanden: createlist, delete, readupdate
workspace-bindings	Opdrachten voor het beheren van beveiligbare werkruimtebindingen. Beveiligbare objecten in Databricks kunnen worden geconfigureerd als OPEN of ISOLATED. get, , , get-bindingsupdateupdate-bindings

Delta-opdrachten voor delen

Groep	Beschrijving en opdrachten
providers	Opdrachten voor het beheren van gegevensproviders, die de organisaties vertegenwoordigen die gegevens delen: create, , deleteget, list, , , list-sharesupdate
recipient-activation	Opdrachten voor het beheren van activering van geadresseerden, die alleen van toepassing zijn in het open sharing-model waarbij het ontvangerobject het verificatietype TOKEN heeft: get-activation-url-info, retrieve-token
recipients	Opdrachten voor het beheren van geadresseerden, die u maakt om :method:recipients/create een organisatie te vertegenwoordigen die u toegang wilt verlenen tot shares: create, , deleteget, list, , , rotate-tokenupdate share-permissions
shares	Opdrachten voor het beheren van shares, die containers zijn die zijn geïnstantieerd met :method:shares/create: createget, delete, listupdate share-permissions, update-permissions

Instellingenopdrachten

Groep	Beschrijving en opdrachten
ip-access-lists	Opdrachten waarmee beheerders IP-toegangslijsten kunnen configureren: create, , deleteget, list, , , replaceupdate
settings	Opdrachten waarmee gebruikers instellingen op werkruimteniveau kunnen beheren: automatic-cluster-updatedefault-namespace, csp-enablement, esm-enablementrestrict-workspace-admins
token-management	Opdrachten waarmee beheerders alle tokens kunnen ophalen en tokens kunnen verwijderen voor andere gebruikers: create-obo-token, , , deletegetlist get-permission-levels, , , get-permissionsset-permissionsupdate-permissions
tokens	Opdrachten voor het maken, weergeven en intrekken van tokens die kunnen worden gebruikt voor het verifiëren en openen van Databricks REST API's: create, , deletelist
workspace-conf	Opdrachten voor het bijwerken van werkruimte-instellingen: get-status, set-status

Opdrachten voor ontwikkelhulpprogramma's

Groep	Beschrijving en opdrachten
bundel	Opdrachten voor het beheren van Databricks Asset Bundles, waarmee u uw Databricks-projecten als code kunt uitdrukken: deploy, , deploymentdestroy, generate, init, , open, , summaryschemasyncrunvalidate
Sync	Een lokale map synchroniseren met een werkruimtemap.

Vectorzoekopdrachten

Groep	Beschrijving en opdrachten
vector-search-endpoints	Opdrachten voor het beheren van vectorzoekeindpunten, die de rekenresources voor het hosten van vectorzoekindexen vertegenwoordigen: create-endpoint, , , delete-endpointget-endpointlist-endpoints
vector-search-indexes	Opdrachten voor het beheren van vectorzoekindexen, een efficiënte weergave van uw insluitvectors die ondersteuning bieden voor realtime en efficiënte bijna dichtstbijzijnde buurquery's (ANN): create-index, , delete-data-vector-indexdelete-index, get-index, , list-indexes, , query-indexsync-indexupsert-data-vector-index

Dashboardopdrachten

Groep	Beschrijving en opdrachten
dashboards	Opdrachten voor het wijzigen van dashboards: create, , deleteget, list, , , restoreupdate
lakeview	Opdrachten die specifieke beheerbewerkingen bieden voor AI/BI-dashboards: create, , getget-published, migrate, , publish, , trashunpublishupdate

Aanvullende opdrachten

Groep	Beschrijving en opdrachten
API	Opdrachten voor het indienen van aanvragen bij de Databricks REST API: delete, , gethead, patch, , , postput
voltooiing	Opdrachten voor het genereren van het script voor automatisch aanvullen voor de opgegeven shell: bash, , , fishpowershellzsh
Configureren	Configureer de Databricks CLI.
help	Gebruiksgegevens voor uitvoer voor elke opdracht.
Labs	Opdrachten voor het beheren van Databricks Labs-installaties: clear-cache, , installinstalled, list, , show, , uninstallupgrade
version	Haal de versie van de CLI op die momenteel wordt gebruikt.

Globale vlaggen

De volgende vlaggen zijn beschikbaar voor alle Databricks CLI-opdrachten. Houd er rekening mee dat sommige vlaggen niet van toepassing zijn op sommige opdrachten. Zie de help van de opdrachtregel voor gedetailleerde informatie over specifieke opdrachten en de bijbehorende vlaggen.

Vlag	Beschrijving
-h of --help	Help weergeven voor de Databricks CLI of de gerelateerde opdrachtgroep of de gerelateerde opdracht.
-e of --environment string	Een tekenreeks die de bundelomgeving vertegenwoordigt die moet worden gebruikt, indien van toepassing voor de gerelateerde opdracht.
--log-file	Een tekenreeks die de uitvoerlogboeken naar schrijft. Als deze vlag niet is opgegeven, is het standaardinstelling om uitvoerlogboeken naar stderr te schrijven.
--log-format	text om uitvoerlogboeken naar tekst te schrijven of json uitvoerlogboeken naar JSON te schrijven. Als deze vlag niet is opgegeven, worden uitvoerlogboeken geschreven als tekst.
--log-level	Een tekenreeks die het niveau van de logboekindeling vertegenwoordigt. Als dit niet is opgegeven, wordt het niveau van de logboekindeling uitgeschakeld.
-o of --output	text om uitvoer als tekst te schrijven of json uitvoer als JSON te schrijven. Als deze vlag niet is opgegeven, wordt de uitvoer geschreven als tekst.
-p of --profile	Een tekenreeks die het benoemde configuratieprofiel vertegenwoordigt dat in uw .databrickscfg bestand moet worden gebruikt. Als deze vlag niet is opgegeven, wordt het DEFAULT benoemde profiel gebruikt als er een bestaat. U kunt erna --profile drukken Tab of -p een lijst met bestaande beschikbare configuratieprofielen weergeven waaruit u kunt kiezen in plaats van de naam van het configuratieprofiel handmatig in te voeren.
--progress-format	De indeling voor voortgangslogboeken die moeten worden weergegeven (defaultde standaardinstelling) of append of inplace ).json