Workspace Settings - Update Spark Settings

Opdater indstillinger for arbejdsområdets spark.

Tilladelser

Kalderen skal have administrator arbejdsområderolle.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Support
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Grænseflade

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

URI-parametre

Navn I Påkrævet Type Beskrivelse
workspaceId
path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Navn Type Beskrivelse
automaticLog

AutomaticLogProperties

Indstillinger for automatisk logføring.

environment

EnvironmentProperties

Miljøindstillinger.

highConcurrency

HighConcurrencyProperties

Indstillinger for høj samtidighed.

job

SparkJobsProperties

Indstillinger for jobadministration.

pool

PoolProperties

Indstillinger for gruppe.

Svar

Navn Type Beskrivelse
200 OK

WorkspaceSparkSettings

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • UnknownError – Der opstod en fejl.

Eksempler

Update workspace Spark settings default pool using pool ID example
Update workspace Spark settings example

Update workspace Spark settings default pool using pool ID example

Eksempelanmodning

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

{
  "pool": {
    "defaultPool": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

Eksempelsvar

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  }
}

Update workspace Spark settings example

Eksempelanmodning

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Eksempelsvar

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Definitioner

Navn Beskrivelse
AutomaticLogProperties

Egenskaber for automatisk logføring.

CustomPoolType

Brugerdefineret gruppetype. Der kan tilføjes flere CustomPoolType typer over tid.

EnvironmentProperties

Egenskaber for et miljø.

ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.

ErrorResponse

Fejlsvaret.

ErrorResponseDetails

Oplysninger om fejlsvar.

HighConcurrencyProperties

Egenskaber for høj samtidighed.

InstancePool

Forekomstpuljen.

PoolProperties

Egenskaber for en gruppe

SparkJobsProperties

Egenskaber for et Spark-job.

StarterPoolProperties

Brugerdefineret startbassin.

UpdateWorkspaceSparkSettingsRequest

Opdater nyttedata for anmodning om spark-indstillinger for arbejdsområde.

WorkspaceSparkSettings

Spark-indstillinger for arbejdsområde.

AutomaticLogProperties

Egenskaber for automatisk logføring.

Navn Type Beskrivelse
enabled

boolean

Status for den automatiske log. False – Deaktiveret, sand – Aktiveret.

CustomPoolType

Brugerdefineret gruppetype. Der kan tilføjes flere CustomPoolType typer over tid.

Værdi Beskrivelse
Workspace

Brugerdefineret gruppe på arbejdsområdeniveau

Capacity

Brugerdefineret gruppe på kapacitetsniveau

EnvironmentProperties

Egenskaber for et miljø.

Navn Type Beskrivelse
name

string

Navnet på standardmiljøet. En tom streng angiver, at der ikke er noget standardmiljø for arbejdsområdet.

runtimeVersion

string

Kørselsversion . Eksempel: 1.3

ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn Type Beskrivelse
message

string

En læsevenlig beskrivelse af parameterens betydning.

name

string

Parameter-id'et.

value

string

Parameterens værdi.

ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.

Navn Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.

resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Fejlsvaret.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.

isRetriable

boolean

Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.

message

string

En menneskelig læsbar gengivelse af fejlen.

moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.

parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.

relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Oplysninger om fejlsvar.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.

message

string

En menneskelig læsbar gengivelse af fejlen.

parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.

relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

HighConcurrencyProperties

Egenskaber for høj samtidighed.

Navn Type Beskrivelse
notebookInteractiveRunEnabled

boolean

Status for den høje samtidighed for interaktiv kørsel af notesbogen. False – Deaktiveret, sand – Aktiveret.

notebookPipelineRunEnabled

boolean

Status for den høje samtidighed for kørsel af notesbogpipeline. False – Deaktiveret, sand – Aktiveret.

InstancePool

Forekomstpuljen.

Navn Type Beskrivelse
id

string (uuid)

Forekomstgruppe-id.

maxClustersToHydrateLimit

integer (int32)

Serverberegnet øvre grænse for indstillingen for den dynamiske pulje maxClustersToHydrate bestemmes af den kapacitetsstørrelse, der er knyttet til denne gruppe.

name

string

Navn på forekomstgruppe.

type

CustomPoolType

Forekomstgruppetype.

PoolProperties

Egenskaber for en gruppe

Navn Type Beskrivelse
customizeComputeEnabled

boolean

Tilpas beregningskonfigurationer for elementer. False – Deaktiveret, sand – Aktiveret.

defaultPool

InstancePool

Standardgruppe for arbejdsområde. Det skal være et gyldigt brugerdefineret gruppenavn. "Startbassin" betyder brug startbassin.

starterPool

StarterPoolProperties

Tilpas startpuljen. Du kan få flere oplysninger om konfiguration af startpuljen under konfiguration af startpuljen.

SparkJobsProperties

Egenskaber for et Spark-job.

Navn Type Beskrivelse
conservativeJobAdmissionEnabled

boolean

Reserve maksimumkerner til aktive Spark-job. Når denne indstilling er aktiveret, reserverer din Fabric-kapacitet det maksimale antal kerner, der er nødvendige for aktive Spark-job, hvilket sikrer jobpålidelighed ved at sikre, at kerner er tilgængelige, hvis et job skaleres op. Når denne indstilling er deaktiveret, startes job baseret på det mindste antal kerner, der kræves, så flere job kan køre på samme tid. Du kan få flere oplysninger under . False – Deaktiveret, sand – Aktiveret.

sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

Tid til at afslutte inaktive Spark-sessioner. Maksimum er 14 dage.

StarterPoolProperties

Brugerdefineret startbassin.

Navn Type Beskrivelse
maxExecutors

integer (int32)

minimum: 1

Det maksimale antal eksekutorer.

maxNodeCount

integer (int32)

minimum: 1

Det maksimale antal noder.

UpdateWorkspaceSparkSettingsRequest

Opdater nyttedata for anmodning om spark-indstillinger for arbejdsområde.

Navn Type Beskrivelse
automaticLog

AutomaticLogProperties

Indstillinger for automatisk logføring.

environment

EnvironmentProperties

Miljøindstillinger.

highConcurrency

HighConcurrencyProperties

Indstillinger for høj samtidighed.

job

SparkJobsProperties

Indstillinger for jobadministration.

pool

PoolProperties

Indstillinger for gruppe.

WorkspaceSparkSettings

Spark-indstillinger for arbejdsområde.

Navn Type Beskrivelse
automaticLog

AutomaticLogProperties

Indstillinger for automatisk logføring.

environment

EnvironmentProperties

Miljøindstillinger.

highConcurrency

HighConcurrencyProperties

Indstillinger for høj samtidighed.

job

SparkJobsProperties

Indstillinger for jobadministration.

pool

PoolProperties

Indstillinger for gruppe.