Zarządzaj ustawieniami za pomocą API Ustawień

API Settings pozwala programowo czytać i aktualizować ustawienia konta, przestrzeni roboczej i użytkownika Azure Databricks, w tym podglądy funkcji na poziomie konta i przestrzeni roboczej. Ta strona wyjaśnia, jak odkrywać dostępne ustawienia oraz jak je czytać i aktualizować. Listę ustawień dostępnych w publicznym API można znaleźć w sekcji Klucze API Ustawienia.

Pełne informacje o punkcie końcowym znajdziesz w API Settings REST.

Note

Wersje zapoznawcze funkcji na poziomie obszaru roboczego i konta są również zarządzane za pomocą interfejsu API Settings v2, ale nie są wymienione w dokumentacji kluczy interfejsu API Settings, ponieważ wersja zapoznawcza ostatecznie osiąga kres cyklu życia, gdy funkcja wychodzi z fazy preview lub zostaje usunięta. Sprawdź, jakie wersje zapoznawcze są obecnie dostępne za pośrednictwem punktu końcowego settings-metadata. Każdy zwracany podgląd można odczytać i aktualizować za pomocą tych samych punktów końcowych get i update (PATCH) jak każde inne ustawienie.

Ustawienia modelu API

API Settings v2 jest dynamiczne. Jedno uogólnione API obsługuje każde ustawienie, a nowe ustawienia są dostępne dzięki niemu bez konieczności wprowadzania nowej wersji API, wydania SDK czy aktualizacji dokumentacji. Zamiast stałej, ręcznie utrzymywanej listy punktów końcowych, odkrywasz, co jest aktualnie konfigurowalne w czasie działania poprzez punkt końcowy metadanych.

Ustawienie ma nazwę, wartość, której kształt zależy od typu settingu, oraz zakres określający miejsce jego zastosowania:

  • Ustawienia konta obowiązują na całym koncie.
  • Ustawienia przestrzeni roboczej dotyczą pojedynczej przestrzeni roboczej.
  • Preferencje użytkownika dotyczą użytkownika na koncie.

Niektóre ustawienia są dostępne w więcej niż jednym zakresie teleskopowym. Ustawienia konta i przestrzeni roboczej zazwyczaj wymagają uprawnień administratora do odczytu lub aktualizacji.

Punkty końcowe według zakresu

Każdy zakres ma własny zestaw punktów końcowych. Użyj tego, który odpowiada sposobowi zarządzania settingiem:

Scope Get Aktualizacja (PATCH)
Konto /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>
Preferencje użytkownika /api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name> /api/2.1/accounts/<account-id>/users/<user-id>/settings/<key-name>

Odkryj dostępne ustawienia

Nazwy ustawień i ich aktualne metadane (w tym typ wartości potrzebny do aktualizacji) są dostępne z punktu końcowego metadanych. To zawsze aktualne, wiarygodne źródło informacji o tym, co można obecnie skonfigurować w obszarze roboczym lub na koncie. Punkt końcowy jest paginowany, więc przeglądaj wyniki, aby pobrać pełną listę:

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

Możesz też wymienić ustawienia w Databricks CLI:

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

Do ustawień konta użyj punktu końcowego metadanych przypisanego do konta:

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

Odczytać ustawienie

Odpowiedź get zwraca dwie wartości dla każdego ustawienia. Wartość zapisana znajduje się w polu typu (na przykład boolean_val) i jest wartością ustawioną. Efektywna wartość znajduje się w odpowiednim effective_* polu (na przykład effective_boolean_val) i jest wartością obliczaną przez serwer po zastosowaniu domyślnych ustawień i wszelkich nadpisań o wyższym zakresie. Na przykład ustawienie boole'a zwraca:

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

Aby odczytać ustawienie obszaru roboczego, wywołaj endpoint get, używając nazwy klucza ustawienia:

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

Aby przeczytać ustawienia konta, użyj ścieżki ograniczonej do konta:

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

Aby odczytać preferencje użytkownika, użyj ścieżki użytkownika dostosowanej do konta. Odczyt i aktualizacja preferencji użytkownika wymaga uprawnień administratora konta:

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

Zaktualizuj ustawienie

Aby zaktualizować ustawienie, wyślij żądanie PATCH , którego treść jest obiektem ustawienia, z wartością zawartą w polu odpowiadającym typowi ustawienia. Użyj list-workspace-settings-metadata (lub punktu końcowego metadanych) do określenia właściwego pola typu dla danego ustawienia. Na przykład, aby zaktualizować ustawienie boolean workspace:

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 }
  }'

Aby zaktualizować ustawienie konta, wyślij tę samą treść do ścieżki w zakresie konta:

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 }
  }'

Aby zaktualizować preferencje użytkownika, wyślij żądanie na ścieżkę użytkownika dostosowaną do konta. Poniższy przykład aktualizuje preferencję typu łańcuchowego:

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>" }
  }'

Dodatkowe zasoby

  • Last updated on