Staging - Get Spark Compute (preview)

Service:: Environment

Version d'API:: v1

Obtenir le calcul spark intermédiaire de l’environnement.

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. Cette API bêta sera déconseillée le 1er mars 2026 et remplacée par une version stable disponible ici. La nouvelle version introduit des changements cassants et n’est pas compatible descendante. Lors de l’appel de cette API, les appelants doivent spécifier true comme valeur pour le paramètre beta de requête (preview le paramètre de requête a été remplacé par beta. Pour la compatibilité descendante, beta il est toujours pris en charge et se comporte de la même façon que beta).

Avis de dépréciation

Un nouveau paramètre beta de requête a été introduit pour faciliter cette transition :

Le beta paramètre de requête est actuellement défini par défaut sur true.
Définissez la valeur du paramètre de beta requête pour false utiliser la version release stable de cette API.
À compter du 1er mars 2026, la valeur par défaut pour beta laquelle la valeur sera modifiée false.

Pour garantir la compatibilité, définissez explicitement le beta paramètre sur la valeur souhaitée (true ou false).

Il est recommandé de migrer votre intégration pour utiliser la version release dès que possible en spécifiant false pour le beta paramètre de requête (la valeur par défaut du beta paramètre de requête sera définie false sur la date de dépréciation de l’API).

Les modifications incompatibles suivantes ont été introduites dans la version release :

Le type de la propriété sparkPropertiesde réponse a été remplacé par object la liste de SparkProperty.

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}/staging/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 `true` utiliser la version bêta décrite dans cette page ou pour `false` utiliser la version release détaillée ici. À compter du 1er mars 2026, la valeur par défaut pour `beta` laquelle la valeur sera modifiée `false`.

Réponses

Nom	Type	Description
200 OK	EnvironmentSparkComputePreview	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

Nom

Type

Description

200 OK

EnvironmentSparkComputePreview

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 staging spark compute example

Exemple de requête

HTTP

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

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": {
    "spark.acls.enable": "false"
  },
  "runtimeVersion": "1.2"
}

Définitions

Nom	Description
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.
EnvironmentSparkComputePreview
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.

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 `maxNodeCount`d’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`.

EnvironmentSparkComputePreview

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	string	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	string	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.
sparkProperties	object	Propriétés Spark. Le contrat basé sur le dictionnaire pour la définition des propriétés Spark sera déconseillé le 31 janvier 2026. Migrez vers l’utilisation d’une liste de paires clé-valeur à la place.

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.

Partager via

Staging - Get Spark Compute (preview)

Avis de dépréciation

Permissions

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Get environment staging spark compute example

Exemple de requête

Exemple de réponse

Définitions

CustomPoolType

DynamicExecutorAllocationProperties

EnvironmentSparkComputePreview

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

InstancePool