Custom Pools - CreateCapacityCustomPool (beta)

Service:: Spark

Version d’API:: v1

Créez un pool personnalisé.

Note

Cette API fait partie d’une version bêta et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production. Lors de l’appel de cette API, les appelants doivent spécifier true comme valeur pour le paramètre betade requête.

Permissions

L’appelant doit être un administrateur de capacité.

Étendues déléguées requises

Capacity.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
capacityId	path	True	string (uuid)	ID de capacité.
beta	query	True	boolean	Ce paramètre obligatoire doit être défini pour accéder à `true` cette API, qui est actuellement en version bêta.

Corps de la demande

Nom	Obligatoire	Type	Description
autoScale	True	AutoScaleProperties	Mise à l’échelle automatique.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Allocation d’exécuteur dynamique.
name	True	string	Nom du pool personnalisé. Le nom doit être compris entre 1 et 64 caractères et ne doit contenir que des lettres, des chiffres, des tirets, des traits de soulignement et des espaces. Les noms de pool personnalisés doivent être uniques dans l’espace de travail. « Pool de démarrage » est un nom de pool personnalisé réservé.
nodeFamily	True	NodeFamily	Famille de nœuds.
nodeSize	True	NodeSize	Taille du nœud.

Réponses

Nom Type Description

201 Created

Nom	Type	Description
201 Created	CustomPool	La demande s’est terminée avec succès. En-têtes : Emplacement`string` - URL du pool nouvellement créé.
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

CustomPool

La demande s’est terminée avec succès.

En-têtes :

Emplacementstring - URL du pool nouvellement créé.

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Create custom pool example

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
AutoScaleProperties	Propriétés de mise à l’échelle automatique.
CreateCustomPoolRequest	Créez une charge utile de demande de pool personnalisée.
CustomPool	Pool personnalisé.
CustomPoolType	Type de pool personnalisé. Des types `CustomPoolType` supplémentaires peuvent être ajoutés au fil du temps.
DynamicExecutorAllocationProperties	Proerties d’allocation d’exécuteur dynamique.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
NodeFamily	Famille de nœuds. Des types `NodeFamily` supplémentaires peuvent être ajoutés au fil du temps.
NodeSize	taille de nœud. Des types `NodeSize` supplémentaires peuvent être ajoutés au fil du temps.

AutoScaleProperties

Objet

Propriétés de mise à l’échelle automatique.

Nom	Type	Description
enabled	boolean	État de l’échelle automatique. False - Désactivé, true - Activé.
maxNodeCount	integer (int32) minimum: 1	Nombre maximal de nœuds.
minNodeCount	integer (int32) minimum: 1	Nombre minimal de nœuds.

CreateCustomPoolRequest

Objet

Créez une charge utile de demande de pool personnalisée.

Nom	Type	Description
autoScale	AutoScaleProperties	Mise à l’échelle automatique.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Allocation d’exécuteur dynamique.
name	string	Nom du pool personnalisé. Le nom doit être compris entre 1 et 64 caractères et ne doit contenir que des lettres, des chiffres, des tirets, des traits de soulignement et des espaces. Les noms de pool personnalisés doivent être uniques dans l’espace de travail. « Pool de démarrage » est un nom de pool personnalisé réservé.
nodeFamily	NodeFamily	Famille de nœuds.
nodeSize	NodeSize	Taille du nœud.

CustomPool

Objet

Pool personnalisé.

Nom	Type	Description
autoScale	AutoScaleProperties	Mise à l’échelle automatique.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Allocation d’exécuteur dynamique.
id	string (uuid)	ID de pool personnalisé.
name	string	Nom du pool personnalisé.
nodeFamily	NodeFamily	Famille de nœuds.
nodeSize	NodeSize	Taille du nœud.
type	CustomPoolType	Type de pool personnalisé.

CustomPoolType

Énumération

Type de pool personnalisé. Des types CustomPoolType supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Workspace	Pool personnalisé au niveau de l’espace de travail
Capacity	Pool personnalisé au niveau de la capacité

DynamicExecutorAllocationProperties

Objet

Proerties d’allocation d’exécuteur dynamique.

Nom	Type	Description
enabled	boolean	État de l’allocation d’exécuteur dynamique. False - Désactivé, true - Activé.
maxExecutors	integer (int32) minimum: 1	Exécuteurs maximum.
minExecutors	integer (int32) minimum: 1	Exécuteurs minimaux.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

NodeFamily

Énumération

Famille de nœuds. Des types NodeFamily supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
MemoryOptimized	Mémoire optimisée

NodeSize

Énumération

taille de nœud. Des types NodeSize supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Small	Petite taille de nœud
Medium	Taille de nœud moyenne
Large	Grande taille de nœud
XLarge	Taille du nœud XLarge
XXLarge	Taille du nœud XXLarge