Delen via

Published - Get Spark Compute (preview)

Service:
Environment
API-versie:
v1

Haal spark-rekenkracht van de omgeving op.

Opmerking

Deze API maakt deel uit van een bètaversie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik. Deze bèta-API wordt op 1 maart 2026 afgeschaft en vervangen door een stabiele versie die hier beschikbaar is. De nieuwe versie introduceert belangrijke wijzigingen en is niet compatibel met eerdere versies. Bij het aanroepen van deze API moeten aanroepers opgeven true als de waarde voor de queryparameter beta (preview de queryparameter is vervangen door beta. Voor achterwaartse compatibiliteit preview wordt nog steeds ondersteund en gedraagt zich hetzelfde als beta).

Afschaffingsmelding

Er is een nieuwe queryparameter beta geïntroduceerd om deze overgang te vergemakkelijken:

  • De beta queryparameter is momenteel standaard ingesteld op true.
  • Stel de waarde van de beta queryparameter in om de stabiele releaseversie van deze API te false gebruiken.
  • Vanaf 1 maart 2026 wordt de standaardwaarde beta gewijzigd in false.

Om compatibiliteit te garanderen, stelt u de beta parameter expliciet in op de gewenste waarde (true of false).

Het wordt aanbevolen om uw integratie zo snel mogelijk te migreren om de releaseversie te gebruiken door op te false geven voor de beta queryparameter (de standaardwaarde voor de queryparameter wordt ingesteld beta op de afschaffingsdatum van de false API).

De volgende incompatibele wijzigingen zijn geïntroduceerd in de releaseversie:

  • Het type van de antwoordeigenschap sparkPropertiesis gewijzigd van object in de lijst met SparkProperty.

Permissions

Leesmachtiging voor het omgevingsitem.

Vereiste gedelegeerde bereiken

Item.Read.All of Item.ReadWrite.All of Environment.Read.All of Environment.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Support
User Yes
serviceprincipal en beheerde identiteiten Yes

gebruikersinterface

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

URI-parameters

Name In Vereist Type Description
environmentId
 path True

string (uuid)

De omgevings-id.
workspaceId
 path True

string (uuid)

De werkruimte-ID.
beta
 query True

boolean

Met deze parameter geeft u op welke versie van de API moet worden gebruikt. Ingesteld op true het gebruik van de bètaversie die op deze pagina wordt beschreven of om false de releaseversie te gebruiken die hier wordt beschreven. Vanaf 1 maart 2026 wordt de standaardwaarde beta gewijzigd in false.

Antwoorden

Name Type Description
200 OK

EnvironmentSparkComputePreview

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • UnknownError: er is een fout opgetreden.

Voorbeelden

Get environment Spark compute example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
}

Definities

Name Description
CustomPoolType

Aangepast pooltype. Er kunnen in de loop van de tijd extra CustomPoolType typen worden toegevoegd.
DynamicExecutorAllocationProperties

Dynamische uitvoerprogrammatoewijzingsproxy's.
EnvironmentSparkComputePreview
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
InstancePool

Een exemplaar van een pool.

CustomPoolType

Opsomming

Aangepast pooltype. Er kunnen in de loop van de tijd extra CustomPoolType typen worden toegevoegd.

Waarde Description
Workspace

Aangepaste werkruimtegroep
Capacity

Aangepaste capaciteitspool

DynamicExecutorAllocationProperties

Object

Dynamische uitvoerprogrammatoewijzingsproxy's.

Name Type Description
enabled

boolean

De status van de dynamische uitvoerderstoewijzing. False - Disabled, true - Enabled.
maxExecutors

integer (int32)

minimum: 1

Het maximum aantal uitvoerders voor dynamische toewijzing en het minimum voor deze eigenschap is 1. De maximumwaarde moet lager zijn dan de exemplaargroep maxNodeCount.
minExecutors

integer (int32)

minimum: 1

Het minimale uitvoerdernummer voor dynamische toewijzing en het minimum voor deze eigenschap is 1. De maximumwaarde moet lager zijn dan maxExecutors.

EnvironmentSparkComputePreview

Object
Name Type Description
driverCores

integer (int32)

Spark-stuurprogrammakern. Moet een van de volgende waarden zijn: 4, 8, 16, 32, 64.
driverMemory

string

Spark-stuurprogrammageheugen.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamische uitvoerdertoewijzing.
executorCores

integer (int32)

Spark-uitvoerderskern. Moet een van de volgende waarden zijn: 4, 8, 16, 32, 64.
executorMemory

string

Spark-uitvoerprogrammageheugen.
instancePool

InstancePool

De omgevingsgroep moet een geldige aangepaste pool zijn. "Starter pool" betekent het gebruik van starterspool.
runtimeVersion

string

Runtimeversie, zoek de ondersteunde fabric-runtimes.
sparkProperties

object

Spark-eigenschappen. Het op woordenlijst gebaseerde contract voor het definiëren van Spark-eigenschappen wordt afgeschaft op 31 januari 2026. Migreer in plaats daarvan naar het gebruik van een lijst met sleutel-waardeparen.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

InstancePool

Object

Een exemplaar van een pool.

Name Type Description
id

string (uuid)

Exemplaargroep-id.
name

string

Naam van exemplaargroep.
type

CustomPoolType

Type exemplaargroep.