Spravujte nastavení přes API Settings

API Settings vám umožní číst a aktualizovat nastavení Azure Databricks účtu, pracovního prostoru a uživatele, včetně náhledů funkcí na úrovni účtu a pracovního prostoru, programovaně. Tato stránka vysvětluje, jak objevit dostupná nastavení a jak je číst a aktualizovat. Pro seznam nastavení dostupných prostřednictvím veřejného API viz odkaz na klíče API Nastavení.

Úplný přehled koncových bodů najdete v REST API nastavení.

Note

Náhledy funkcí na úrovni pracovního prostoru a účtu jsou také spravovány přes API Settings v2, ale nejsou uvedeny v referenci klíčů API Nastavení , protože náhled nakonec skončí, když funkce skončí nebo je odstraněna. Zjistěte, které verze Preview jsou vám aktuálně dostupné pomocí koncového bodu settings-metadata. Každý vrácený náhled lze číst i aktualizovat prostřednictvím stejných koncových bodů get a update (PATCH) stejně jako jakékoli jiné nastavení.

Nastavení modelu API

API Settings v2 je dynamické. Jediné, obecné API obsluhuje každé nastavení a nová nastavení jsou dostupná bez nové verze API, vydání SDK nebo aktualizace dokumentace. Místo pevného, ručně spravovaného seznamu koncových bodů objevujete, co je aktuálně nastaveno za běhu, prostřednictvím metadatového endpointu.

Nastavení má název, hodnotu, jejíž tvar závisí na typu nastavení, a rozsah, který určuje, kde se uplatňuje:

  • Nastavení účtu platí napříč celým účtem.
  • Nastavení pracovního prostoru platí pro jeden pracovní prostor.
  • Uživatelské preference se vztahují na uživatele v účtu.

Některá nastavení jsou dostupná na více než jednom rozsahu. Nastavení účtu a pracovního prostoru obvykle vyžaduje administrátorská oprávnění pro čtení nebo aktualizaci.

Koncové body podle rozsahu

Každý rozsah má svou vlastní sadu koncových bodů. Použijte ten, který odpovídá způsobu správy nastavení:

Scope Získat Aktualizace (PATCH)
Účet /api/2.1/accounts/<account-id>/settings/<key-name> /api/2.1/accounts/<account-id>/settings/<key-name>
Workspace /api/2.1/settings/<key-name> /api/2.1/settings/<key-name>
Preference uživatele /api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name> /api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name>

Objevte dostupná nastavení

Názvy nastavení a jejich aktuální metadata (včetně typu hodnoty potřebné pro aktualizace) jsou dostupné z metadata endpointu. Toto je vždy aktuální spolehlivý zdroj informací o tom, co lze aktuálně nastavit ve vašem pracovním prostoru nebo účtu. Koncový bod je stránkován, proto prolistujte výsledky a získejte kompletní seznam:

curl -n --request GET \
  'https://<databricks-instance>/api/2.1/settings-metadata'

Nastavení můžete také uvádět v Databricks CLI:

databricks workspace-settings-v2 list-workspace-settings-metadata

Pro nastavení účtu použijte místo toho koncový bod metadat zaměřený na účet:

curl -n --request GET \
  'https://<databricks-instance>/api/2.1/accounts/<account-id>/settings-metadata'

Čtěte nastavení

Odpověď na požadavek GET vrací pro každé nastavení dvě hodnoty. Uložená hodnota je v poli typu (například ) a je to hodnota, boolean_valkterá byla nastavena. Efektivní hodnota je v příslušném effective_* poli (například ) a je to hodnota, effective_boolean_valkterou server vypočítá po aplikaci výchozích nastavení a případných přepsání s vyšším rozsahem. Například booleovské nastavení vrací:

{
  "name": "<key-name>",
  "boolean_val": { "value": true },
  "effective_boolean_val": { "value": true }
}

Pro čtení nastavení pracovního prostoru zavolejte get endpoint s názvem klíče nastavení:

curl -n --request GET \
  'https://<databricks-instance>/api/2.1/settings/<key-name>'

Chcete-li číst nastavení účtu, použijte cestu s rozsahem účtu:

curl -n --request GET \
  'https://<databricks-instance>/api/2.1/accounts/<account-id>/settings/<key-name>'

Pro přečtení uživatelských preferencí použijte uživatelskou cestu zaměřenou na účet. Čtení a aktualizace uživatelských preferencí vyžaduje oprávnění správce účtu:

curl -n --request GET \
  'https://<databricks-instance>/api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name>'

Aktualizovat nastavení

Pro aktualizaci nastavení pošlete PATCH požadavek, jehož tělo je objektem nastavení, s hodnotou uvedenou v poli, která odpovídá typu nastavení. Použijte list-workspace-settings-metadata (nebo metadata endpoint) k určení správného typového pole pro dané nastavení. Například pro aktualizaci nastavení booleovského pracovního prostoru:

curl -n --request PATCH \
  'https://<databricks-instance>/api/2.1/settings/<key-name>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "<key-name>",
    "boolean_val": { "value": true }
  }'

Pro aktualizaci nastavení účtu pošlete stejný text do cesty zaměřené na účet:

curl -n --request PATCH \
  'https://<databricks-instance>/api/2.1/accounts/<account-id>/settings/<key-name>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "<key-name>",
    "boolean_val": { "value": true }
  }'

Pro aktualizaci uživatelských preferencí pošlete požadavek na uživatelskou cestu zaměřenou na účet. Níže uvedený příklad aktualizuje preferenci typu řetězce:

curl -n --request PATCH \
  'https://<databricks-instance>/api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "<key-name>",
    "string_val": { "value": "<value>" }
  }'

Dodatečné zdroje

  • Poslední aktualizace v