Staging - Update Spark Compute

Usługa:: Environment

Wersja interfejsu API:: v1

Aktualizowanie środowiska przejściowego obliczeń platformy Spark. Jeśli chcesz usunąć właściwość spark, ustaw jej wartość na wartość null.

Uwaga / Notatka

Ten interfejs API jest wersją wersji beta, która zostanie wycofana 31 sierpnia 2026 r. Podczas wywoływania tego interfejsu API obiekt wywołujący musi ustawić parametr beta zapytania na wartość false

Permissions

Uprawnienie do zapisu dla elementu środowiska.

Wymagane zakresy delegowane

Item.ReadWrite.All lub Environment.ReadWrite.All

Microsoft Entra obsługiwane tożsamości

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute?beta={beta}

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
environmentId	path	True	string (uuid)	Identyfikator środowiska.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
beta	query	True	boolean	Ten parametr określa, która wersja interfejsu API ma być używana. Ustaw wartość na , aby `false` używać wersji wydania.

Treść żądania

Nazwisko	Typ	Opis
customLivePoolSettings	CustomLivePoolSettings	Ustawienia nawodnienia puli na żywo. Przekaż, `null` aby całkowicie usunąć ustawienia nawodnienia. Pomiń pozostawienie istniejącej wartości bez zmian.
customLivePoolSupport	CustomLivePoolSupport	Określa, czy pula na żywo jest aktywna. Ustawienie `Disabled` powoduje wyłączenie, ale zachowuje ustawienia nawodnienia. Pomiń pozostawienie istniejącej wartości bez zmian.
driverCores	integer (int32)	Rdzenie sterowników platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Pamięć sterownika platformy Spark.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
executorCores	integer (int32)	Rdzeń funkcji wykonawczej platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Pamięć funkcji wykonawczej platformy Spark.
instancePool	InstancePool	Pula środowisk musi być prawidłową pulą niestandardową. Nazwa domyślnej puli obszarów roboczych to Pula początkowa.
runtimeVersion	string	Wersja środowiska uruchomieniowego— znajdź obsługiwane środowiska uruchomieniowe sieci szkieletowej. Na przykład: 1.3
sparkProperties	SparkProperty[]	Właściwości platformy Spark.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK	EnvironmentSparkCompute	Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

EnvironmentSparkCompute

Żądanie zostało ukończone pomyślnie.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

Update environment staging spark compute example

Update environment staging spark compute instance pool using pool ID example

Update environment staging spark compute example

Przykładowe żądanie

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=false

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2",
  "customLivePoolSupport": "Enabled",
  "customLivePoolSettings": {
    "maxClustersToHydrate": 4,
    "clusterIdleTimeout": "PT20M",
    "customLivePoolLifespan": "PT1H"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603",
    "maxClustersToHydrateLimit": 10
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2",
  "customLivePoolSupport": "Enabled",
  "customLivePoolSettings": {
    "maxClustersToHydrate": 4,
    "clusterIdleTimeout": "PT20M",
    "customLivePoolLifespan": "PT1H"
  }
}

Update environment staging spark compute instance pool using pool ID example

Przykładowe żądanie

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=false

{
  "instancePool": {
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603",
    "maxClustersToHydrateLimit": 10
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Definicje

Nazwisko	Opis
CustomLivePoolSettings	Ustawienia nawodnienia puli na żywo na obliczeniach platformy Spark w środowisku.
CustomLivePoolSupport	Flaga kontrolowania, czy obsługa puli na żywo jest aktywna. Dodatkowe `CustomLivePoolSupport` wartości mogą być dodawane w czasie.
CustomPoolMemory	Niestandardowa pamięć puli dla sterownika platformy Spark lub funkcji wykonawczej platformy Spark. Dodatkowe typy `CustomPoolMemory` można dodawać w czasie.
CustomPoolType	Typ puli niestandardowej. Dodatkowe typy `CustomPoolType` można dodawać w czasie.
DynamicExecutorAllocationProperties	Dynamiczne zalety alokacji funkcji wykonawczej.
EnvironmentSparkCompute
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
InstancePool	Pula wystąpień.
SparkProperty	Klucz właściwości platformy Spark i jego wartość.
UpdateEnvironmentSparkComputeRequest

CustomLivePoolSettings

Objekt

Ustawienia nawodnienia puli na żywo na obliczeniach platformy Spark w środowisku.

Nazwisko	Typ	Opis
clusterIdleTimeout	string (duration)	Próg czasu bezczynności, po którym zostanie zwolniony nawodniony klaster przy użyciu formatu czasu trwania ISO 8601. Minimum: PT20M. Maksymalna: PT24H.
customLivePoolLifespan	string (duration)	Maksymalny okres istnienia aktywacji puli na żywo przy użyciu formatu czasu trwania ISO 8601. Zadanie puli na żywo jest uruchamiane przez ten czas, a następnie kończy działanie. Minimum: PT30M. Maksymalna: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Maksymalna liczba klastrów do wstępnego nawodnienia podczas każdego cyklu aktywacji. Minimum: 1. Maksymalna dozwolona wartość jest określana przez rozmiar pojemności i jest widoczna w ustawieniach puli wystąpień jako `InstancePool.maxClustersToHydrateLimit`.

CustomLivePoolSupport

Wyliczenie

Flaga kontrolowania, czy obsługa puli na żywo jest aktywna. Dodatkowe CustomLivePoolSupport wartości mogą być dodawane w czasie.

Wartość	Opis
Enabled	Obsługa puli na żywo jest aktywna.
Disabled	Obsługa puli na żywo jest nieaktywna. Konfiguracja jest zachowywana.

CustomPoolMemory

Wyliczenie

Niestandardowa pamięć puli dla sterownika platformy Spark lub funkcji wykonawczej platformy Spark. Dodatkowe typy CustomPoolMemory można dodawać w czasie.

Wartość	Opis
28g	28 GB pamięci.
56g	Pamięć 56G.
112g	Pamięć 112G.
224g	Pamięć 224G.
400g	Pamięć 400G.

CustomPoolType

Wyliczenie

Typ puli niestandardowej. Dodatkowe typy CustomPoolType można dodawać w czasie.

Wartość	Opis
Workspace	Pula niestandardowa na poziomie obszaru roboczego
Capacity	Pula niestandardowa na poziomie pojemności

DynamicExecutorAllocationProperties

Objekt

Dynamiczne zalety alokacji funkcji wykonawczej.

Nazwisko	Typ	Opis
enabled	boolean	Stan alokacji funkcji wykonawczej dynamicznej. Fałsz — wyłączone, true — włączone.
maxExecutors	integer (int32) minimum: 1	Maksymalna liczba funkcji wykonawczej dla alokacji dynamicznej i minimalna dla tej właściwości to 1. Wartość maksymalna musi być niższa niż pula `maxNodeCount`wystąpień.
minExecutors	integer (int32) minimum: 1	Minimalna liczba funkcji wykonawczej dla alokacji dynamicznej i minimalna dla tej właściwości to 1. Wartość maksymalna musi być niższa niż `maxExecutors`.

EnvironmentSparkCompute

Objekt

Nazwisko	Typ	Opis
customLivePoolSettings	CustomLivePoolSettings	Ustawienia nawodnienia puli na żywo. Określa sposób, w jaki klastry są wstępnie nawodnione po włączeniu obsługi puli na żywo.
customLivePoolSupport	CustomLivePoolSupport	Określa, czy pula na żywo jest włączona. Gdy `Enabled`klastery są wstępnie nawodnione zgodnie z ustawieniami nawodnienia, dzięki czemu obciążenia zaczynają się bez opóźnienia zimnego startu.
driverCores	integer (int32)	Rdzenie sterowników platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Pamięć sterownika platformy Spark.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
executorCores	integer (int32)	Rdzeń funkcji wykonawczej platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Pamięć funkcji wykonawczej platformy Spark.
instancePool	InstancePool	Pula środowisk musi być prawidłową pulą niestandardową. "Pula początkowa" oznacza użycie puli początkowej.
runtimeVersion	string	Wersja środowiska uruchomieniowego— znajdź obsługiwane środowiska uruchomieniowe sieci szkieletowej. Na przykład: 1.3
sparkProperties	SparkProperty[]	Właściwości platformy Spark.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

InstancePool

Objekt

Pula wystąpień.

Nazwisko	Typ	Opis
id	string (uuid)	Identyfikator puli wystąpień.
maxClustersToHydrateLimit	integer (int32)	Obliczana górna granica serwera dla ustawienia puli `maxClustersToHydrate` na żywo określona przez rozmiar pojemności skojarzony z tą pulą.
name	string	Nazwa puli wystąpień.
type	CustomPoolType	Typ puli wystąpień.

SparkProperty

Objekt

Klucz właściwości platformy Spark i jego wartość.

Nazwisko	Typ	Opis
key	string	Klucz właściwości platformy Spark.
value	string	Wartość właściwości Platformy Spark.

UpdateEnvironmentSparkComputeRequest

Objekt

Nazwisko	Typ	Opis
customLivePoolSettings	CustomLivePoolSettings	Ustawienia nawodnienia puli na żywo. Przekaż, `null` aby całkowicie usunąć ustawienia nawodnienia. Pomiń pozostawienie istniejącej wartości bez zmian.
customLivePoolSupport	CustomLivePoolSupport	Określa, czy pula na żywo jest aktywna. Ustawienie `Disabled` powoduje wyłączenie, ale zachowuje ustawienia nawodnienia. Pomiń pozostawienie istniejącej wartości bez zmian.
driverCores	integer (int32)	Rdzenie sterowników platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Pamięć sterownika platformy Spark.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
executorCores	integer (int32)	Rdzeń funkcji wykonawczej platformy Spark. Musi być jedną z następujących wartości: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Pamięć funkcji wykonawczej platformy Spark.
instancePool	InstancePool	Pula środowisk musi być prawidłową pulą niestandardową. Nazwa domyślnej puli obszarów roboczych to Pula początkowa.
runtimeVersion	string	Wersja środowiska uruchomieniowego— znajdź obsługiwane środowiska uruchomieniowe sieci szkieletowej. Na przykład: 1.3
sparkProperties	SparkProperty[]	Właściwości platformy Spark.