Custom Pools - CreateCapacityCustomPool (beta)

Servizio:: Spark

Versione API:: v1

Creare un pool personalizzato.

Note

Questa API fa parte di una versione beta e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione. Quando si chiama questa API, i chiamanti devono specificare true come valore per il parametro betadi query .

Permissions

Il chiamante deve essere un amministratore della capacità.

Ambiti delegati obbligatori

Capacity.ReadWrite.All

Identità supportate da Microsoft Entra

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

Identità	Support
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
capacityId	path	True	string (uuid)	ID di capacità.
beta	query	True	boolean	Questo parametro obbligatorio deve essere impostato su per accedere a `true` questa API, attualmente in versione beta.

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

Nome	Tipo	Descrizione
201 Created	CustomPool	Richiesta completata correttamente. Intestazioni: Posizione`string` - URL del pool appena creato.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

CustomPool

Richiesta completata correttamente.

Intestazioni:

Posizionestring - URL del pool appena creato.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

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

Risposta di esempio

Codice di stato:: 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
  }
}

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 dei dettagli della risorsa relativo 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

Oggetto

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

Oggetto

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

Oggetto

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

Oggetto

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

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

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

ErrorResponse

Oggetto

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.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

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