Custom Pools - Create Workspace Custom Pool

Tjeneste:: Spark

API-versjon:: v1

Opprett egendefinert utvalg.

Tillatelser

Innringeren må ha administrator arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Name	Obligatorisk	Type	Beskrivelse
autoScale	True	AutoScaleProperties	Autoskala.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynamisk eksekutortildeling.
name	True	string	Egendefinert utvalgsnavn. Navnet må være mellom 1 og 64 tegn og må bare inneholde bokstaver, tall, bindestreker, understrekingstegn og mellomrom. Egendefinerte utvalgsnavn må være unike i arbeidsområdet. "Startutvalg" er et reservert egendefinert utvalgsnavn.
nodeFamily	True	NodeFamily	Nodefamilie.
nodeSize	True	NodeSize	Nodestørrelse.

Svar

Name Type Beskrivelse

201 Created

Name	Type	Beskrivelse
201 Created	CustomPool	Forespørselen er fullført. Overskrifter Location: string
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

CustomPool

Forespørselen er fullført.

Overskrifter

Location: string

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

UnknownError - Det oppstod en feil.

Eksempler

Create custom pool example

Eksempelforespørsel

HTTP

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

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Eksempelsvar

Statuskode:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Workspace",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Definisjoner

Name	Beskrivelse
AutoScaleProperties	Egenskaper for autoskala.
CreateCustomPoolRequest	Opprett nyttelast for egendefinert utvalgsforespørsel.
CustomPool	Egendefinert utvalg.
CustomPoolType	Egendefinert utvalgstype. Flere `CustomPoolType` typer kan legges til over tid.
DynamicExecutorAllocationProperties	Dynamiske fordelinger for eksekutortildeling.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
NodeFamily	Nodefamilie. Flere `NodeFamily` typer kan legges til over tid.
NodeSize	nodestørrelse. Flere `NodeSize` typer kan legges til over tid.

AutoScaleProperties

Objekt

Egenskaper for autoskala.

Name	Type	Beskrivelse
enabled	boolean	Statusen for den automatiske skalaen. False - Deaktivert, sann - Aktivert.
maxNodeCount	integer (int32) minimum: 1	Maksimalt antall noder.
minNodeCount	integer (int32) minimum: 1	Minimum antall noder.

CreateCustomPoolRequest

Objekt

Opprett nyttelast for egendefinert utvalgsforespørsel.

Name	Type	Beskrivelse
autoScale	AutoScaleProperties	Autoskala.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekutortildeling.
name	string	Egendefinert utvalgsnavn. Navnet må være mellom 1 og 64 tegn og må bare inneholde bokstaver, tall, bindestreker, understrekingstegn og mellomrom. Egendefinerte utvalgsnavn må være unike i arbeidsområdet. "Startutvalg" er et reservert egendefinert utvalgsnavn.
nodeFamily	NodeFamily	Nodefamilie.
nodeSize	NodeSize	Nodestørrelse.

CustomPool

Objekt

Egendefinert utvalg.

Name	Type	Beskrivelse
autoScale	AutoScaleProperties	Autoskala.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekutortildeling.
id	string (uuid)	Egendefinert utvalgs-ID.
name	string	Egendefinert utvalgsnavn.
nodeFamily	NodeFamily	Nodefamilie.
nodeSize	NodeSize	Nodestørrelse.
type	CustomPoolType	Egendefinert utvalgstype.

CustomPoolType

Opplisting

Egendefinert utvalgstype. Flere CustomPoolType typer kan legges til over tid.

Verdi	Beskrivelse
Workspace	Egendefinert utvalg på arbeidsområdenivå
Capacity	Egendefinert utvalg på kapasitetsnivå

DynamicExecutorAllocationProperties

Objekt

Dynamiske fordelinger for eksekutortildeling.

Name	Type	Beskrivelse
enabled	boolean	Statusen for den dynamiske eksekutortildelingen. False - Deaktivert, sann - Aktivert.
maxExecutors	integer (int32) minimum: 1	Maksimalt antall eksekutorer.
minExecutors	integer (int32) minimum: 1	Minimums eksekutorer.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

NodeFamily

Opplisting

Nodefamilie. Flere NodeFamily typer kan legges til over tid.

Verdi	Beskrivelse
MemoryOptimized	Minneoptimert

NodeSize

Opplisting

nodestørrelse. Flere NodeSize typer kan legges til over tid.

Verdi	Beskrivelse
Small	Liten nodestørrelse
Medium	Middels nodestørrelse
Large	Stor nodestørrelse
XLarge	XLarge-nodestørrelse
XXLarge	XXLarge-nodestørrelse