Custom Pools - Get Workspace Custom Pool

Tjänst:

Spark

API-version:

v1

Hämta en anpassad pool.

Behörigheter

Anroparen måste ha visningsprogram eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.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.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
poolId	path	True	string (uuid)	Det anpassade pool-ID:t.
workspaceId	path	True	string (uuid)	Arbetsmiljöns ID.

Svar

Name	Typ	Description
200 OK	CustomPool	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod.

Exempel

Get custom pool example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
AutoScaleProperties	Autoskalningsegenskaper.
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	Information om felsvar.
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.

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
Capacity	Anpassad pool på kapacitetsnivå
Workspace	Anpassad pool på arbetsyta

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	Det resurs-ID som ingår 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.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

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	Felrelaterad resursinformation.

NodeFamily

Uppräkning

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

Värde	Description
MemoryOptimized	Minnesoptimerad

NodeSize

Uppräkning

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

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