Custom Pools - Update Workspace Custom Pool

Szolgáltatás:

Spark

API-verzió:

v1

Egyéni készlet frissítése.

Engedélyek

A hívónak rendszergazdai munkaterületi szerepkörével kell rendelkeznie.

Kötelező delegált hatókörök

Workspace.ReadWrite.All

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Identitás	Támogatás
Felhasználó	Igen
szolgáltatásnév és felügyelt identitások	Igen

Interfész

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
poolId	path	True	string (uuid)	Az egyéni készlet azonosítója.
workspaceId	path	True	string (uuid)	A munkaterület azonosítója.

Kérelem törzse

Name	Típus	Description
autoScale	AutoScaleProperties	Automatikus skálázás.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dinamikus végrehajtói lefoglalás.
name	string	Egyéni készlet neve. A névnek 1 és 64 karakter közötti hosszúságúnak kell lennie, és csak betűket, számokat, kötőjeleket, aláhúzásjeleket és szóközöket tartalmazhat. Az egyéni készletneveknek egyedinek kell lenniük a munkaterületen belül. A "Kezdőkészlet" egy fenntartott egyéni készlet neve.
nodeFamily	NodeFamily	Csomópontcsalád.
nodeSize	NodeSize	Csomópont mérete.

Válaszok

Name	Típus	Description
200 OK	CustomPool	A kérés sikeresen befejeződött.
Other Status Codes	ErrorResponse	Gyakori hibakódok: UnknownError – Hiba történt.

Példák

Update custom pool example

Mintakérelem

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
AutoScaleProperties	Automatikus skálázási tulajdonságok.
CustomPool	Egyéni készlet.
CustomPoolType	Egyéni készlettípus. Idővel további CustomPoolType típusok is hozzáadhatók.
DynamicExecutorAllocationProperties	Dinamikus végrehajtói foglalási proerties.
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
NodeFamily	Csomópontcsalád. Idővel további NodeFamily típusok is hozzáadhatók.
NodeSize	csomópontméret. Idővel további NodeSize típusok is hozzáadhatók.
UpdateCustomPoolRequest	Az egyéni készletkérelem hasznos adatainak frissítése.

AutoScaleProperties

Objektum

Automatikus skálázási tulajdonságok.

Name	Típus	Description
enabled	boolean	Az automatikus skálázás állapota. Hamis – Letiltva, igaz – Engedélyezve.
maxNodeCount	integer (int32) minimum: 1	A csomópontok maximális száma.
minNodeCount	integer (int32) minimum: 1	A csomópontok minimális száma.

CustomPool

Objektum

Egyéni készlet.

Name	Típus	Description
autoScale	AutoScaleProperties	Automatikus skálázás.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dinamikus végrehajtói lefoglalás.
id	string (uuid)	Egyéni készletazonosító.
name	string	Egyéni készlet neve.
nodeFamily	NodeFamily	Csomópontcsalád.
nodeSize	NodeSize	Csomópont mérete.
type	CustomPoolType	Egyéni készlettípus.

CustomPoolType

Enumerálás

Egyéni készlettípus. Idővel további CustomPoolType típusok is hozzáadhatók.

Érték	Description
Capacity	Kapacitásszintű egyéni készlet
Workspace	Munkaterületszintű egyéni készlet

DynamicExecutorAllocationProperties

Objektum

Dinamikus végrehajtói foglalási proerties.

Name	Típus	Description
enabled	boolean	A dinamikus végrehajtói foglalás állapota. Hamis – Letiltva, igaz – Engedélyezve.
maxExecutors	integer (int32) minimum: 1	A maximális végrehajtók.
minExecutors	integer (int32) minimum: 1	A minimális végrehajtók.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

NodeFamily

Enumerálás

Csomópontcsalád. Idővel további NodeFamily típusok is hozzáadhatók.

Érték	Description
MemoryOptimized	Memória optimalizált

NodeSize

Enumerálás

csomópontméret. Idővel további NodeSize típusok is hozzáadhatók.

Érték	Description
Large	Nagy csomópontméret
Medium	Közepes csomópontméret
Small	Kis csomópontméret
XLarge	XLarge-csomópont mérete
XXLarge	XXLarge csomópont mérete

UpdateCustomPoolRequest

Objektum

Az egyéni készletkérelem hasznos adatainak frissítése.

Name	Típus	Description
autoScale	AutoScaleProperties	Automatikus skálázás.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dinamikus végrehajtói lefoglalás.
name	string	Egyéni készlet neve. A névnek 1 és 64 karakter közötti hosszúságúnak kell lennie, és csak betűket, számokat, kötőjeleket, aláhúzásjeleket és szóközöket tartalmazhat. Az egyéni készletneveknek egyedinek kell lenniük a munkaterületen belül. A "Kezdőkészlet" egy fenntartott egyéni készlet neve.
nodeFamily	NodeFamily	Csomópontcsalád.
nodeSize	NodeSize	Csomópont mérete.