Custom Pools - Create Workspace Custom Pool

Servizio:

Spark

Versione API:

v1

Creare un pool personalizzato.

Autorizzazioni

Il chiamante deve avere ruolo amministratore'area di lavoro.

Ambiti delegati obbligatori

Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
autoScale	True	AutoScaleProperties	Abilitare la scalabilità automatica.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Allocazione dell'executor dinamico.
name	True	string	Nome pool personalizzato. Il nome deve avere una lunghezza compresa tra 1 e 64 caratteri e deve contenere solo lettere, numeri, trattini, caratteri di sottolineatura e spazi. I nomi dei pool personalizzati devono essere univoci all'interno dell'area di lavoro. "Pool di avvio" è un nome di pool personalizzato riservato.
nodeFamily	True	NodeFamily	Famiglia di nodi.
nodeSize	True	NodeSize	Dimensioni del nodo.

Risposte

Nome	Tipo	Descrizione
201 Created	CustomPool	Richiesta completata correttamente. Intestazioni Location: string
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

Esempio

Create custom pool example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AutoScaleProperties	Proprietà di scalabilità automatica.
CreateCustomPoolRequest	Creare un payload di richiesta del pool personalizzato.
CustomPool	Pool personalizzato.
CustomPoolType	Tipo di pool personalizzato. È possibile aggiungere altri tipi di CustomPoolType nel tempo.
DynamicExecutorAllocationProperties	Proerità di allocazione dell'executor dinamico.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
NodeFamily	Famiglia di nodi. È possibile aggiungere altri tipi di NodeFamily nel tempo.
NodeSize	dimensioni del nodo. È possibile aggiungere altri tipi di NodeSize nel tempo.

AutoScaleProperties

Object

Proprietà di scalabilità automatica.

Nome	Tipo	Descrizione
enabled	boolean	Stato della scalabilità automatica. False - Disabilitato, true - Abilitato.
maxNodeCount	integer (int32) minimum: 1	Numero massimo di nodi.
minNodeCount	integer (int32) minimum: 1	Numero minimo di nodi.

CreateCustomPoolRequest

Object

Creare un payload di richiesta del pool personalizzato.

Nome	Tipo	Descrizione
autoScale	AutoScaleProperties	Abilitare la scalabilità automatica.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Allocazione dell'executor dinamico.
name	string	Nome pool personalizzato. Il nome deve avere una lunghezza compresa tra 1 e 64 caratteri e deve contenere solo lettere, numeri, trattini, caratteri di sottolineatura e spazi. I nomi dei pool personalizzati devono essere univoci all'interno dell'area di lavoro. "Pool di avvio" è un nome di pool personalizzato riservato.
nodeFamily	NodeFamily	Famiglia di nodi.
nodeSize	NodeSize	Dimensioni del nodo.

CustomPool

Object

Pool personalizzato.

Nome	Tipo	Descrizione
autoScale	AutoScaleProperties	Abilitare la scalabilità automatica.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Allocazione dell'executor dinamico.
id	string (uuid)	ID pool personalizzato.
name	string	Nome pool personalizzato.
nodeFamily	NodeFamily	Famiglia di nodi.
nodeSize	NodeSize	Dimensioni del nodo.
type	CustomPoolType	Tipo di pool personalizzato.

CustomPoolType

Enumerazione

Tipo di pool personalizzato. È possibile aggiungere altri tipi di CustomPoolType nel tempo.

Valore	Descrizione
Workspace	Pool personalizzato a livello di area di lavoro
Capacity	Pool personalizzato a livello di capacità

DynamicExecutorAllocationProperties

Object

Proerità di allocazione dell'executor dinamico.

Nome	Tipo	Descrizione
enabled	boolean	Stato dell'allocazione dell'executor dinamico. False - Disabilitato, true - Abilitato.
maxExecutors	integer (int32) minimum: 1	Numero massimo di executor.
minExecutors	integer (int32) minimum: 1	Executor minimo.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

NodeFamily

Enumerazione

Famiglia di nodi. È possibile aggiungere altri tipi di NodeFamily nel tempo.

Valore	Descrizione
MemoryOptimized	Ottimizzata per l'uso della memoria

NodeSize

Enumerazione

dimensioni del nodo. È possibile aggiungere altri tipi di NodeSize nel tempo.

Valore	Descrizione
Small	Dimensioni dei nodi di piccole dimensioni
Medium	Dimensioni medie dei nodi
Large	Dimensioni dei nodi di grandi dimensioni
XLarge	Dimensioni del nodo XLarge
XXLarge	Dimensioni del nodo XXLarge