Freigeben über

Workspace Settings - Update Spark Settings

Dienst:
Spark
API-Version:
v1

Aktualisieren der Spark-Einstellungen des Arbeitsbereichs.

Erlaubnisse

Der Anrufer muss über Administratorrolle Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
automaticLog

AutomaticLogProperties

Automatische Protokolleinstellungen.
environment

EnvironmentProperties

Umgebungseinstellungen.
highConcurrency

HighConcurrencyProperties

Einstellungen für hohe Parallelität.
job

SparkJobsProperties

Auftragsverwaltungseinstellungen.
pool

PoolProperties

Pooleinstellungen.

Antworten

Name Typ Beschreibung
200 OK

WorkspaceSparkSettings

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

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

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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
  }
}

Definitionen

Name Beschreibung
AutomaticLogProperties

Automatische Protokolleigenschaften.
CustomPoolType

Benutzerdefinierter Pooltyp. Zusätzliche CustomPoolType Typen können im Laufe der Zeit hinzugefügt werden.
EnvironmentProperties

Eigenschaften einer Umgebung.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
HighConcurrencyProperties

Hohe Parallelitätseigenschaften.
InstancePool
PoolProperties

Eigenschaften eines Pools
SparkJobsProperties

Eigenschaften eines Spark-Auftrags.
StarterPoolProperties

Benutzerdefinierter Startpool.
UpdateWorkspaceSparkSettingsRequest

Aktualisieren der Spark-Einstellungsanforderungsnutzlast des Arbeitsbereichs.
WorkspaceSparkSettings

Arbeitsbereichs-Spark-Einstellungen.

AutomaticLogProperties

Objekt

Automatische Protokolleigenschaften.

Name Typ Beschreibung
enabled

boolean

Der Status des automatischen Protokolls. False – Deaktiviert, true – Aktiviert.

CustomPoolType

Enumeration

Benutzerdefinierter Pooltyp. Zusätzliche CustomPoolType Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Workspace

Benutzerdefinierter Pool auf Arbeitsbereichsebene
Capacity

Benutzerdefinierter Pool auf Kapazitätsebene

EnvironmentProperties

Objekt

Eigenschaften einer Umgebung.

Name Typ Beschreibung
name

string

Der Name der Standardumgebung. Leere Zeichenfolge gibt an, dass keine Arbeitsbereichsstandardumgebung vorhanden ist.
runtimeVersion

string

Runtime Version. Beispiel: 1.3

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

HighConcurrencyProperties

Objekt

Hohe Parallelitätseigenschaften.

Name Typ Beschreibung
notebookInteractiveRunEnabled

boolean

Der Status der hohen Parallelität für die interaktive Ausführung des Notizbuchs. False – Deaktiviert, true – Aktiviert.
notebookPipelineRunEnabled

boolean

Der Status der hohen Parallelität für die Notizbuchpipelineausführung. False – Deaktiviert, true – Aktiviert.

InstancePool

Objekt
Name Typ Beschreibung
id

string (uuid)

Instanzpool-ID.
name

string

Name des Instanzpools.
type

CustomPoolType

Instanzpooltyp.

PoolProperties

Objekt

Eigenschaften eines Pools

Name Typ Beschreibung
customizeComputeEnabled

boolean

Anpassen von Computekonfigurationen für Elemente. False – Deaktiviert, true – Aktiviert.
defaultPool

InstancePool

Standardpool für Arbeitsbereich. Es sollte ein gültiger benutzerdefinierter Poolname sein. "StarterPool" bedeutet, den Startpool zu verwenden.
starterPool

StarterPoolProperties

Anpassen des Startpools. Weitere Informationen zum Konfigurieren des Startpools finden Sie unter Konfigurieren des Startpools.

SparkJobsProperties

Objekt

Eigenschaften eines Spark-Auftrags.

Name Typ Beschreibung
conservativeJobAdmissionEnabled

boolean

Reservieren Sie maximale Kerne für aktive Spark-Aufträge. Wenn diese Einstellung aktiviert ist, behält sich Ihre Fabric-Kapazität die maximale Anzahl von Kernen vor, die für aktive Spark-Aufträge erforderlich sind, um die Zuverlässigkeit der Aufträge sicherzustellen, indem sichergestellt wird, dass Kerne verfügbar sind, wenn ein Auftrag skaliert wird. Wenn diese Einstellung deaktiviert ist, werden Aufträge basierend auf der Mindestanzahl der benötigten Kerne gestartet, sodass mehr Aufträge gleichzeitig ausgeführt werden können. Weitere Informationen finden Sie . False – Deaktiviert, true – Aktiviert.
sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

Zeit zum Beenden inaktiver Spark-Sitzungen. Der Höchstwert ist 14 Tage.

StarterPoolProperties

Objekt

Benutzerdefinierter Startpool.

Name Typ Beschreibung
maxExecutors

integer (int32)

minimum: 1

Die maximale Anzahl der Executoren.
maxNodeCount

integer (int32)

minimum: 1

Die maximale Knotenanzahl.

UpdateWorkspaceSparkSettingsRequest

Objekt

Aktualisieren der Spark-Einstellungsanforderungsnutzlast des Arbeitsbereichs.

Name Typ Beschreibung
automaticLog

AutomaticLogProperties

Automatische Protokolleinstellungen.
environment

EnvironmentProperties

Umgebungseinstellungen.
highConcurrency

HighConcurrencyProperties

Einstellungen für hohe Parallelität.
job

SparkJobsProperties

Auftragsverwaltungseinstellungen.
pool

PoolProperties

Pooleinstellungen.

WorkspaceSparkSettings

Objekt

Arbeitsbereichs-Spark-Einstellungen.

Name Typ Beschreibung
automaticLog

AutomaticLogProperties

Automatische Protokolleinstellungen.
environment

EnvironmentProperties

Umgebungseinstellungen.
highConcurrency

HighConcurrencyProperties

Einstellungen für hohe Parallelität.
job

SparkJobsProperties

Auftragsverwaltungseinstellungen.
pool

PoolProperties

Pooleinstellungen.