Delen via

Staging - Update Spark Compute

Service:
Environment
API-versie:
v1

Werk spark-rekenkracht voor fasering van de omgeving bij. Als u een Spark-eigenschap wilt verwijderen, stelt u de waarde ervan in op null.

Opmerking

Deze API is een releaseversie van een bètaversie die is afgeschaft op 1 maart 2026. Bij het aanroepen van deze API moeten aanroepers de queryparameter beta instellen op de waarde false

Permissions

Schrijfmachtiging voor het omgevingsitem.

Vereiste gedelegeerde bereiken

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/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 false het gebruik van de releaseversie.

Aanvraagbody

Name Type Description
driverCores

integer (int32)

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

CustomPoolMemory

Spark-stuurprogrammageheugen.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamische uitvoerdertoewijzing.
executorCores

integer (int32)

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

CustomPoolMemory

Spark-uitvoerprogrammageheugen.
instancePool

InstancePool

De omgevingsgroep moet een geldige aangepaste pool zijn. De naam voor een standaardwerkruimtegroep is Starter-pool.
runtimeVersion

string

Runtimeversie, zoek de ondersteunde fabric-runtimes. Bijvoorbeeld: 1.3
sparkProperties

SparkProperty[]

Spark-eigenschappen.

Antwoorden

Name Type Description
200 OK

EnvironmentSparkCompute

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • UnknownError: er is een fout opgetreden.

Voorbeelden

Update environment staging spark compute example
Update environment staging spark compute instance pool using pool ID example

Update environment staging spark compute example

Voorbeeldaanvraag

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

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

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

Update environment staging spark compute instance pool using pool ID example

Voorbeeldaanvraag

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

{
  "instancePool": {
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  }
}

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

Definities

Name Description
CustomPoolMemory

Aangepast poolgeheugen voor Spark-stuurprogramma of Spark-uitvoerprogramma. Er kunnen in de loop van de tijd extra CustomPoolMemory typen worden toegevoegd.
CustomPoolType

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

Dynamische uitvoerprogrammatoewijzingsproxy's.
EnvironmentSparkCompute
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
InstancePool

Een exemplaar van een pool.
SparkProperty

Een Spark-eigenschapssleutel en de bijbehorende waarde.
UpdateEnvironmentSparkComputeRequest

CustomPoolMemory

Opsomming

Aangepast poolgeheugen voor Spark-stuurprogramma of Spark-uitvoerprogramma. Er kunnen in de loop van de tijd extra CustomPoolMemory typen worden toegevoegd.

Waarde Description
28g

28 GB geheugen.
56g

56G geheugen.
112g

112G geheugen.
224g

224G geheugen.
400g

400G geheugen.

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.

EnvironmentSparkCompute

Object
Name Type Description
driverCores

integer (int32)

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

CustomPoolMemory

Spark-stuurprogrammageheugen.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamische uitvoerdertoewijzing.
executorCores

integer (int32)

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

CustomPoolMemory

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. Bijvoorbeeld: 1.3
sparkProperties

SparkProperty[]

Spark-eigenschappen.

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.

SparkProperty

Object

Een Spark-eigenschapssleutel en de bijbehorende waarde.

Name Type Description
key

string

De Spark-eigenschapssleutel.
value

string

De waarde van de Spark-eigenschap.

UpdateEnvironmentSparkComputeRequest

Object
Name Type Description
driverCores

integer (int32)

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

CustomPoolMemory

Spark-stuurprogrammageheugen.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamische uitvoerdertoewijzing.
executorCores

integer (int32)

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

CustomPoolMemory

Spark-uitvoerprogrammageheugen.
instancePool

InstancePool

De omgevingsgroep moet een geldige aangepaste pool zijn. De naam voor een standaardwerkruimtegroep is Starter-pool.
runtimeVersion

string

Runtimeversie, zoek de ondersteunde fabric-runtimes. Bijvoorbeeld: 1.3
sparkProperties

SparkProperty[]

Spark-eigenschappen.