Partager via

Custom Pools - Update Workspace Custom Pool

Service:
Spark
Version d'API:
v1

Mettre à jour un pool personnalisé.

Autorisations

L’appelant doit avoir rôle d’administrateur espace de travail.

Étendues déléguées requises

Workspace.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é Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
poolId
 path True

string (uuid)

ID de pool personnalisé.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

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.

Réponses

Nom Type Description
200 OK

CustomPool

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

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Update custom pool example

Exemple de requête

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

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

Définitions

Nom Description
AutoScaleProperties

Propriétés de mise à l’échelle automatique.
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.
UpdateCustomPoolRequest

Mettre à jour la charge utile de demande de pool personnalisé.

AutoScaleProperties

Object

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.

CustomPool

Object

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

Object

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

Object

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

Object

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.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

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

UpdateCustomPoolRequest

Object

Mettre à jour la charge utile de demande de pool personnalisé.

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.