Custom Pools - UpdateCapacityCustomPool (beta)

Dienst:: Spark

API-Version:: v1

Aktualisieren sie den benutzerdefinierten Pool.

Note

Diese API ist Teil einer Betaversion und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Beim Aufrufen dieser API müssen Aufrufer als Wert für den Abfrageparameter trueangebenbeta.

Erlaubnisse

Der Anrufer muss ein Kapazitätsadministrator sein.

Erforderliche delegierte Zugriffsbereiche

Capacity.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

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

Identity	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Interface

PATCH https://api.fabric.microsoft.com/v1/capacities/{capacityId}/spark/pools/{poolId}?beta={beta}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
capacityId	path	True	string (uuid)	Die Kapazitäts-ID.
poolId	path	True	string (uuid)	Die benutzerdefinierte Pool-ID.
beta	query	True	boolean	Dieser erforderliche Parameter muss für den Zugriff auf diese API festgelegt `true` werden, die sich derzeit in der Betaversion befindet.

Anforderungstext

Name	Typ	Beschreibung
autoScale	AutoScaleProperties	Autoskalierung.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische Ausführungszuweisung.
name	string	Benutzerdefinierter Poolname. Der Name muss zwischen 1 und 64 Zeichen lang sein und darf nur Buchstaben, Zahlen, Gedankenstriche, Unterstriche und Leerzeichen enthalten. Benutzerdefinierte Poolnamen müssen innerhalb des Arbeitsbereichs eindeutig sein. "Starter Pool" ist ein reservierter benutzerdefinierter Poolname.
nodeFamily	NodeFamily	Knotenfamilie.
nodeSize	NodeSize	Knotengröße.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	CustomPool	Der Auftrag wurde erfolgreich abgeschlossen.
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

CustomPool

Der Auftrag wurde erfolgreich abgeschlossen.

429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Update custom pool example

Beispielanforderung

HTTP

PATCH https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7?beta=True

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Capacity",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Definitionen

Name	Beschreibung
AutoScaleProperties	Autoskaleneigenschaften.
CustomPool	Benutzerdefinierter Pool.
CustomPoolType	Benutzerdefinierter Pooltyp. Zusätzliche `CustomPoolType` Typen können im Laufe der Zeit hinzugefügt werden.
DynamicExecutorAllocationProperties	Dynamischer Zuweisungsprozeur.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
NodeFamily	Knotenfamilie. Zusätzliche `NodeFamily` Typen können im Laufe der Zeit hinzugefügt werden.
NodeSize	Knotengröße. Zusätzliche `NodeSize` Typen können im Laufe der Zeit hinzugefügt werden.
UpdateCustomPoolRequest	Aktualisieren sie die Nutzlast der benutzerdefinierten Poolanforderung.

AutoScaleProperties

Objekt

Autoskaleneigenschaften.

Name	Typ	Beschreibung
enabled	boolean	Der Status der automatischen Skalierung. False – Deaktiviert, true – Aktiviert.
maxNodeCount	integer (int32) minimum: 1	Die maximale Knotenanzahl.
minNodeCount	integer (int32) minimum: 1	Die minimale Knotenanzahl.

CustomPool

Objekt

Benutzerdefinierter Pool.

Name	Typ	Beschreibung
autoScale	AutoScaleProperties	Autoskalierung.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische Ausführungszuweisung.
id	string (uuid)	Benutzerdefinierte Pool-ID.
name	string	Benutzerdefinierter Poolname.
nodeFamily	NodeFamily	Knotenfamilie.
nodeSize	NodeSize	Knotengröße.
type	CustomPoolType	Benutzerdefinierter Pooltyp.

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

DynamicExecutorAllocationProperties

Objekt

Dynamischer Zuweisungsprozeur.

Name	Typ	Beschreibung
enabled	boolean	Der Status der dynamischen Executorzuordnung. False – Deaktiviert, true – Aktiviert.
maxExecutors	integer (int32) minimum: 1	Die maximalen Executoren.
minExecutors	integer (int32) minimum: 1	Die Minimalausführer.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

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.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	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 menschenlesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

NodeFamily

Enumeration

Knotenfamilie. Zusätzliche NodeFamily Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
MemoryOptimized	Arbeitsspeicheroptimiert

NodeSize

Enumeration

Knotengröße. Zusätzliche NodeSize Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Small	Kleine Knotengröße
Medium	Mittlere Knotengröße
Large	Große Knotengröße
XLarge	XLarge-Knotengröße
XXLarge	Größe des Knotens XXLarge

UpdateCustomPoolRequest

Objekt

Aktualisieren sie die Nutzlast der benutzerdefinierten Poolanforderung.

Name	Typ	Beschreibung
autoScale	AutoScaleProperties	Autoskalierung.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische Ausführungszuweisung.
name	string	Benutzerdefinierter Poolname. Der Name muss zwischen 1 und 64 Zeichen lang sein und darf nur Buchstaben, Zahlen, Gedankenstriche, Unterstriche und Leerzeichen enthalten. Benutzerdefinierte Poolnamen müssen innerhalb des Arbeitsbereichs eindeutig sein. "Starter Pool" ist ein reservierter benutzerdefinierter Poolname.
nodeFamily	NodeFamily	Knotenfamilie.
nodeSize	NodeSize	Knotengröße.