Custom Pools - CreateCapacityCustomPool (beta)

Tjänst:: Spark

API-version:: v1

Skapa en anpassad pool.

Note

Det här API:et är en del av en betaversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning. När du anropar det här API:et måste anropare ange true som värde för frågeparametern beta.

Behörigheter

Anroparen måste vara kapacitetsadministratör.

Obligatoriska delegerade omfång

Capacity.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Interface

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
capacityId	path	True	string (uuid)	Kapacitets-IDn.
beta	query	True	boolean	Den här obligatoriska parametern måste anges för att få åtkomst till `true` det här API:et, som för närvarande är i betaversion.

Begärandetext

Name	Obligatorisk	Typ	Description
autoScale	True	AutoScaleProperties	Autoskalning.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynamisk körallokering.
name	True	string	Namn på anpassad pool. Namnet måste vara mellan 1 och 64 tecken långt och får endast innehålla bokstäver, siffror, bindestreck, understreck och blanksteg. Namn på anpassade pooler måste vara unika på arbetsytan. "Startpool" är ett reserverat anpassat poolnamn.
nodeFamily	True	NodeFamily	Nodfamilj.
nodeSize	True	NodeSize	Nodstorlek.

Svar

Name Typ Description

201 Created

Name	Typ	Description
201 Created	CustomPool	Begäran har slutförts. Headers: Plats`string` – URL:en för den nyligen skapade poolen.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod.

CustomPool

Begäran har slutförts.

Headers:

Platsstring – URL:en för den nyligen skapade poolen.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – Ett fel uppstod.

Exempel

Create custom pool example

Exempelbegäran

HTTP

POST https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools?beta=True

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

Exempelsvar

Statuskod:: 201

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

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

Definitioner

Name	Description
AutoScaleProperties	Autoskalningsegenskaper.
CreateCustomPoolRequest	Skapa nyttolast för anpassad poolbegäran.
CustomPool	Anpassad pool.
CustomPoolType	Typ av anpassad pool. Ytterligare `CustomPoolType` typer kan läggas till över tid.
DynamicExecutorAllocationProperties	Proerties för dynamisk exekutorallokering.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
NodeFamily	Nodfamilj. Ytterligare `NodeFamily` typer kan läggas till över tid.
NodeSize	Nodstorlek. Ytterligare `NodeSize` typer kan läggas till över tid.

AutoScaleProperties

Objekt

Autoskalningsegenskaper.

Name	Typ	Description
enabled	boolean	Status för den automatiska skalningen. Falskt – inaktiverat, sant – aktiverat.
maxNodeCount	integer (int32) minimum: 1	Maximalt antal noder.
minNodeCount	integer (int32) minimum: 1	Minsta antal noder.

CreateCustomPoolRequest

Objekt

Skapa nyttolast för anpassad poolbegäran.

Name	Typ	Description
autoScale	AutoScaleProperties	Autoskalning.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk körallokering.
name	string	Namn på anpassad pool. Namnet måste vara mellan 1 och 64 tecken långt och får endast innehålla bokstäver, siffror, bindestreck, understreck och blanksteg. Namn på anpassade pooler måste vara unika på arbetsytan. "Startpool" är ett reserverat anpassat poolnamn.
nodeFamily	NodeFamily	Nodfamilj.
nodeSize	NodeSize	Nodstorlek.

CustomPool

Objekt

Anpassad pool.

Name	Typ	Description
autoScale	AutoScaleProperties	Autoskalning.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk körallokering.
id	string (uuid)	Anpassat pool-ID.
name	string	Namn på anpassad pool.
nodeFamily	NodeFamily	Nodfamilj.
nodeSize	NodeSize	Nodstorlek.
type	CustomPoolType	Typ av anpassad pool.

CustomPoolType

Uppräkning

Typ av anpassad pool. Ytterligare CustomPoolType typer kan läggas till över tid.

Värde	Description
Workspace	Anpassad pool på arbetsyta
Capacity	Anpassad pool på kapacitetsnivå

DynamicExecutorAllocationProperties

Objekt

Proerties för dynamisk exekutorallokering.

Name	Typ	Description
enabled	boolean	Status för den dynamiska körallokeringen. Falskt – inaktiverat, sant – aktiverat.
maxExecutors	integer (int32) minimum: 1	Maximalt antal körbara filer.
minExecutors	integer (int32) minimum: 1	Minimiexekutorer.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

NodeFamily

Uppräkning

Nodfamilj. Ytterligare NodeFamily typer kan läggas till över tid.

Värde	Description
MemoryOptimized	Minne optimerat

NodeSize

Uppräkning

Nodstorlek. Ytterligare NodeSize typer kan läggas till över tid.

Värde	Description
Small	Liten nodstorlek
Medium	Medelhög nodstorlek
Large	Stor nodstorlek
XLarge	XLarge-nodstorlek
XXLarge	XXLarge nodstorlek