Custom Pools - Create Workspace Custom Pool

Služba:

Spark

Verze rozhraní API:

v1

Vytvořte vlastní fond.

Dovolení

Volající musí mít roli správce pracovního prostoru.

Požadované delegovaná rozsahy

Workspace.ReadWrite.All

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
instančního objektu a spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
autoScale	True	AutoScaleProperties	Automatické škálování:
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Přidělení dynamického exekutoru
name	True	string	Název vlastního fondu Název musí mít délku 1 až 64 znaků a musí obsahovat jenom písmena, číslice, pomlčky, podtržítka a mezery. Názvy vlastních fondů musí být v rámci pracovního prostoru jedinečné. Počáteční fond je vyhrazený název vlastního fondu.
nodeFamily	True	NodeFamily	Řada uzlů
nodeSize	True	NodeSize	Velikost uzlu

Odpovědi

Name	Typ	Description
201 Created	CustomPool	Žádost byla úspěšně dokončena. Hlavičky Location: string
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neznámá chyba – došlo k chybě.

Příklady

Create custom pool example

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

201

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

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

Definice

Name	Description
AutoScaleProperties	Vlastnosti automatického škálování
CreateCustomPoolRequest	Vytvořte datovou část žádosti o vlastní fond.
CustomPool	Vlastní fond.
CustomPoolType	Vlastní typ fondu. V průběhu času je možné přidat další typy CustomPoolType.
DynamicExecutorAllocationProperties	Proerties přidělení dynamického exekutoru
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
NodeFamily	Řada uzlů V průběhu času je možné přidat další typy NodeFamily.
NodeSize	velikost uzlu. V průběhu času je možné přidat další typy NodeSize.

AutoScaleProperties

Objekt

Vlastnosti automatického škálování

Name	Typ	Description
enabled	boolean	Stav automatického škálování False – Zakázáno, true – Povoleno.
maxNodeCount	integer (int32) minimum: 1	Maximální počet uzlů.
minNodeCount	integer (int32) minimum: 1	Minimální počet uzlů.

CreateCustomPoolRequest

Objekt

Vytvořte datovou část žádosti o vlastní fond.

Name	Typ	Description
autoScale	AutoScaleProperties	Automatické škálování:
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Přidělení dynamického exekutoru
name	string	Název vlastního fondu Název musí mít délku 1 až 64 znaků a musí obsahovat jenom písmena, číslice, pomlčky, podtržítka a mezery. Názvy vlastních fondů musí být v rámci pracovního prostoru jedinečné. Počáteční fond je vyhrazený název vlastního fondu.
nodeFamily	NodeFamily	Řada uzlů
nodeSize	NodeSize	Velikost uzlu

CustomPool

Objekt

Vlastní fond.

Name	Typ	Description
autoScale	AutoScaleProperties	Automatické škálování:
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Přidělení dynamického exekutoru
id	string (uuid)	ID vlastního fondu.
name	string	Název vlastního fondu
nodeFamily	NodeFamily	Řada uzlů
nodeSize	NodeSize	Velikost uzlu
type	CustomPoolType	Vlastní typ fondu.

CustomPoolType

Výčet

Vlastní typ fondu. V průběhu času je možné přidat další typy CustomPoolType.

Hodnota	Description
Workspace	Vlastní fond na úrovni pracovního prostoru
Capacity	Vlastní fond na úrovni kapacity

DynamicExecutorAllocationProperties

Objekt

Proerties přidělení dynamického exekutoru

Name	Typ	Description
enabled	boolean	Stav přidělení dynamického exekutoru. False – Zakázáno, true – Povoleno.
maxExecutors	integer (int32) minimum: 1	Maximální počet exekutorů.
minExecutors	integer (int32) minimum: 1	Minimální exekutory.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

NodeFamily

Výčet

Řada uzlů V průběhu času je možné přidat další typy NodeFamily.

Hodnota	Description
MemoryOptimized	Optimalizováno pro paměť

NodeSize

Výčet

velikost uzlu. V průběhu času je možné přidat další typy NodeSize.

Hodnota	Description
Small	Malá velikost uzlu
Medium	Střední velikost uzlu
Large	Velká velikost uzlu
XLarge	Velikost uzlu XLarge
XXLarge	Velikost uzlu XXLarge