Udostępnij przez

Workspace Settings - Update Spark Settings

Usługa:
Spark
Wersja interfejsu API:
v1

Aktualizowanie ustawień platformy Spark obszaru roboczego.

Uprawnienia

Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

Wymagane zakresy delegowane

Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
jednostki usługi i tożsamości zarządzanych Tak

Interfejs

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/settings

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Typ Opis
automaticLog

AutomaticLogProperties

Ustawienia dziennika automatycznego.
environment

EnvironmentProperties

Ustawienia środowiska.
highConcurrency

HighConcurrencyProperties

Ustawienia wysokiej współbieżności.
job

SparkJobsProperties

Ustawienia zarządzania zadaniami.
pool

PoolProperties

Ustawienia puli.

Odpowiedzi

Nazwa Typ Opis
200 OK

WorkspaceSparkSettings

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

ErrorResponse

Typowe kody błędów:

  • UnknownError — wystąpił błąd.

Przykłady

Update workspace Spark settings default pool using pool ID example
Update workspace Spark settings example

Update workspace Spark settings default pool using pool ID example

Przykładowe żądanie

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

{
  "pool": {
    "defaultPool": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  }
}

Update workspace Spark settings example

Przykładowe żądanie

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Definicje

Nazwa Opis
AutomaticLogProperties

Właściwości dziennika automatycznego.
CustomPoolType

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

Właściwości środowiska.
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
HighConcurrencyProperties

Właściwości wysokiej współbieżności.
InstancePool
PoolProperties

Właściwości puli
SparkJobsProperties

Właściwości zadania platformy Spark.
StarterPoolProperties

Niestandardowa pula startowa.
UpdateWorkspaceSparkSettingsRequest

Aktualizowanie ładunku żądania ładunku żądań ustawień platformy Spark w obszarze roboczym.
WorkspaceSparkSettings

Ustawienia platformy Spark obszaru roboczego.

AutomaticLogProperties

Objekt

Właściwości dziennika automatycznego.

Nazwa Typ Opis
enabled

boolean

Stan dziennika automatycznego. Fałsz — wyłączone, true — włączone.

CustomPoolType

Wyliczanie

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

EnvironmentProperties

Objekt

Właściwości środowiska.

Nazwa Typ Opis
name

string

Nazwa środowiska domyślnego. Pusty ciąg wskazuje, że nie ma domyślnego środowiska obszaru roboczego.
runtimeVersion

string

wersja środowiska uruchomieniowego. Na przykład: 1.3

ErrorRelatedResource

Objekt

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

Nazwa 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.

Nazwa 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.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa 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.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

HighConcurrencyProperties

Objekt

Właściwości wysokiej współbieżności.

Nazwa Typ Opis
notebookInteractiveRunEnabled

boolean

Stan wysokiej współbieżności dla interakcyjnego przebiegu notesu. Fałsz — wyłączone, true — włączone.
notebookPipelineRunEnabled

boolean

Stan wysokiego współbieżności dla uruchomienia potoku notesu. Fałsz — wyłączone, true — włączone.

InstancePool

Objekt
Nazwa Typ Opis
id

string (uuid)

Identyfikator puli wystąpień.
name

string

Nazwa puli wystąpień.
type

CustomPoolType

Typ puli wystąpień.

PoolProperties

Objekt

Właściwości puli

Nazwa Typ Opis
customizeComputeEnabled

boolean

Dostosowywanie konfiguracji obliczeniowych dla elementów. Fałsz — wyłączone, true — włączone.
defaultPool

InstancePool

Domyślna pula dla obszaru roboczego. Powinna to być prawidłowa nazwa puli niestandardowej. "Pula początkowa" oznacza użycie puli początkowej.
starterPool

StarterPoolProperties

Dostosuj pulę początkową. Aby uzyskać więcej informacji na temat konfigurowania puli startowej, zobacz konfigurowanie puli początkowej.

SparkJobsProperties

Objekt

Właściwości zadania platformy Spark.

Nazwa Typ Opis
conservativeJobAdmissionEnabled

boolean

Zarezerwuj maksymalne rdzenie dla aktywnych zadań platformy Spark. Po włączeniu tego ustawienia pojemność sieci szkieletowej rezerwuje maksymalną liczbę rdzeni potrzebnych dla aktywnych zadań platformy Spark, zapewniając niezawodność zadań, upewniając się, że rdzenie są dostępne w przypadku skalowania zadania w górę. Gdy to ustawienie jest wyłączone, zadania są uruchamiane na podstawie minimalnej wymaganej liczby rdzeni, co pozwala jednocześnie uruchamiać więcej zadań. Aby uzyskać więcej informacji, zobacz job admission and management. Fałsz — wyłączone, true — włączone.
sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

Czas zakończenia nieaktywnych sesji platformy Spark. Maksymalna wartość to 14 dni.

StarterPoolProperties

Objekt

Niestandardowa pula startowa.

Nazwa Typ Opis
maxExecutors

integer (int32)

minimum: 1

Maksymalna liczba funkcji wykonawczych.
maxNodeCount

integer (int32)

minimum: 1

Maksymalna liczba węzłów.

UpdateWorkspaceSparkSettingsRequest

Objekt

Aktualizowanie ładunku żądania ładunku żądań ustawień platformy Spark w obszarze roboczym.

Nazwa Typ Opis
automaticLog

AutomaticLogProperties

Ustawienia dziennika automatycznego.
environment

EnvironmentProperties

Ustawienia środowiska.
highConcurrency

HighConcurrencyProperties

Ustawienia wysokiej współbieżności.
job

SparkJobsProperties

Ustawienia zarządzania zadaniami.
pool

PoolProperties

Ustawienia puli.

WorkspaceSparkSettings

Objekt

Ustawienia platformy Spark obszaru roboczego.

Nazwa Typ Opis
automaticLog

AutomaticLogProperties

Ustawienia dziennika automatycznego.
environment

EnvironmentProperties

Ustawienia środowiska.
highConcurrency

HighConcurrencyProperties

Ustawienia wysokiej współbieżności.
job

SparkJobsProperties

Ustawienia zarządzania zadaniami.
pool

PoolProperties

Ustawienia puli.