Partager via

Published - Get Spark Compute

Service:
Environment
Version d'API:
v1

Obtenir le calcul Spark de l’environnement.

Note

Cette API est une version release d’une version bêta en raison d’être déconseillée le 1er mars 2026. Lors de l’appel de cette API, les appelants doivent définir le paramètre beta de requête sur la valeur false

Permissions

l’autorisation Lecture pour l’élément d’environnement.

Étendues déléguées requises

Item.Read.All ou Item.ReadWrite.All ou Environment.Read.All ou Environment.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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta={beta}

Paramètres URI

Nom Dans Obligatoire Type Description
environmentId
 path True

string (uuid)

ID d’environnement.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
beta
 query True

boolean

Ce paramètre spécifie la version de l’API à utiliser. Définissez cette option pour false utiliser la version de mise en production.

Réponses

Nom Type Description
200 OK

EnvironmentSparkCompute

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

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Get environment Spark compute example

Exemple de requête

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?beta=false

Exemple de réponse

Code d’état:
200 
{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Définitions

Nom Description
CustomPoolMemory

Mémoire de pool personnalisée pour le pilote Spark ou l’exécuteur Spark. Des types CustomPoolMemory supplémentaires peuvent être ajoutés au fil du temps.
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.
EnvironmentSparkCompute
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Instance d’un pool.
SparkProperty

Clé de propriété Spark et sa valeur.

CustomPoolMemory

Énumération

Mémoire de pool personnalisée pour le pilote Spark ou l’exécuteur Spark. Des types CustomPoolMemory supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
28g

Mémoire de 28 Go.
56g

Mémoire 56G.
112g

Mémoire 112G.
224g

Mémoire 224G.
400g

Mémoire 400G.

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é d’espace de travail
Capacity

Pool personnalisé de 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

Le nombre d’exécuteur maximal pour l’allocation dynamique et le minimum pour cette propriété est 1. La valeur maximale doit être inférieure au pool maxNodeCountd’instances.
minExecutors

integer (int32)

minimum: 1

Le numéro d’exécuteur minimal pour l’allocation dynamique et le minimum pour cette propriété est 1. La valeur maximale doit être inférieure à maxExecutors.

EnvironmentSparkCompute

Objet
Nom Type Description
driverCores

integer (int32)

Cœur du pilote Spark. Doit être l’une des valeurs suivantes : 4, 8, 16, 32, 64.
driverMemory

CustomPoolMemory

Mémoire du pilote Spark.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Allocation d’exécuteur dynamique.
executorCores

integer (int32)

Cœur de l’exécuteur Spark. Doit être l’une des valeurs suivantes : 4, 8, 16, 32, 64.
executorMemory

CustomPoolMemory

Mémoire de l’exécuteur Spark.
instancePool

InstancePool

Le pool d’environnement doit être un pool personnalisé valide. « Pool de démarrage » signifie utiliser le pool de démarrage.
runtimeVersion

string

Version du runtime, recherchez les runtimes d’infrastructure pris en charge. Par exemple : 1.3
sparkProperties

SparkProperty[]

Propriétés Spark.

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

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.

InstancePool

Objet

Instance d’un pool.

Nom Type Description
id

string (uuid)

ID du pool d’instances.
name

string

Nom du pool d’instances.
type

CustomPoolType

Type de pool d’instances.

SparkProperty

Objet

Clé de propriété Spark et sa valeur.

Nom Type Description
key

string

Clé de propriété Spark.
value

string

Valeur de la propriété Spark.