Custom Pools - CreateCapacityCustomPool (beta)

Tjeneste:: Spark

API-version:: v1

Opret en brugerdefineret pulje.

Bemærkning

Denne API er en del af en betaversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug. Når du kalder denne API, skal kaldere angive true som værdien for forespørgselsparameteren beta.

Tilladelser

Den, der ringer op, skal være kapacitetsadministrator.

Påkrævede delegerede områder

Capacity.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

POST https://api.fabric.microsoft.com/v1/capacities/{capacityId}/spark/pools?beta={beta}

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
capacityId	path	True	string (uuid)	Kapacitets-id'et.
beta	query	True	boolean	Denne påkrævede parameter skal angives til for at `true` få adgang til denne API, som i øjeblikket er i beta.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
autoScale	True	AutoScaleProperties	Automatisk skalering.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynamisk eksekveringsallokering.
name	True	string	Navn på brugerdefineret gruppe. Navnet skal være mellem 1 og 64 tegn langt og må kun indeholde bogstaver, tal, tankestreger, understregningstegn og mellemrum. Brugerdefinerede gruppenavne skal være entydige i arbejdsområdet. "Startpulje" er et reserveret brugerdefineret gruppenavn.
nodeFamily	True	NodeFamily	Nodefamilie.
nodeSize	True	NodeSize	Nodestørrelse.

Svar

Name Type Beskrivelse

201 Created

Name	Type	Beskrivelse
201 Created	CustomPool	Anmodningen blev fuldført. Overskrifter: Placering`string` – URL-adressen til den nyoprettede gruppe.
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.

CustomPool

Anmodningen blev fuldført.

Overskrifter:

Placeringstring – URL-adressen til den nyoprettede gruppe.

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

Create custom pool example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools?beta=True

{
  "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/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

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

Definitioner

Name	Beskrivelse
AutoScaleProperties	Egenskaber for automatisk skalering.
CreateCustomPoolRequest	Opret nyttedata for brugerdefinerede gruppeanmodninger.
CustomPool	Brugerdefineret pulje.
CustomPoolType	Brugerdefineret gruppetype. Der kan tilføjes flere `CustomPoolType` typer over tid.
DynamicExecutorAllocationProperties	Fordele ved dynamisk eksekvering.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
NodeFamily	Nodefamilie. Der kan tilføjes flere `NodeFamily` typer over tid.
NodeSize	nodestørrelsen. Der kan tilføjes flere `NodeSize` typer over tid.

AutoScaleProperties

Objekt

Egenskaber for automatisk skalering.

Name	Type	Beskrivelse
enabled	boolean	Status for automatisk skalering. False – Deaktiveret, sand – Aktiveret.
maxNodeCount	integer (int32) minimum: 1	Det maksimale antal noder.
minNodeCount	integer (int32) minimum: 1	Det mindste nodeantal.

CreateCustomPoolRequest

Objekt

Opret nyttedata for brugerdefinerede gruppeanmodninger.

Name	Type	Beskrivelse
autoScale	AutoScaleProperties	Automatisk skalering.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekveringsallokering.
name	string	Navn på brugerdefineret gruppe. Navnet skal være mellem 1 og 64 tegn langt og må kun indeholde bogstaver, tal, tankestreger, understregningstegn og mellemrum. Brugerdefinerede gruppenavne skal være entydige i arbejdsområdet. "Startpulje" er et reserveret brugerdefineret gruppenavn.
nodeFamily	NodeFamily	Nodefamilie.
nodeSize	NodeSize	Nodestørrelse.

CustomPool

Objekt

Brugerdefineret pulje.

Name	Type	Beskrivelse
autoScale	AutoScaleProperties	Automatisk skalering.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekveringsallokering.
id	string (uuid)	Brugerdefineret gruppe-id.
name	string	Navn på brugerdefineret gruppe.
nodeFamily	NodeFamily	Nodefamilie.
nodeSize	NodeSize	Nodestørrelse.
type	CustomPoolType	Brugerdefineret gruppetype.

CustomPoolType

Optælling

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

DynamicExecutorAllocationProperties

Objekt

Fordele ved dynamisk eksekvering.

Name	Type	Beskrivelse
enabled	boolean	Status for den dynamiske eksekveringsallokering. False – Deaktiveret, sand – Aktiveret.
maxExecutors	integer (int32) minimum: 1	Det maksimale antal eksekverere.
minExecutors	integer (int32) minimum: 1	Den mindste eksekvering.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	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.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	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.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

NodeFamily

Optælling

Nodefamilie. Der kan tilføjes flere NodeFamily typer over tid.

Værdi	Beskrivelse
MemoryOptimized	Hukommelse optimeret

NodeSize

Optælling

nodestørrelsen. Der kan tilføjes flere NodeSize typer over tid.

Værdi	Beskrivelse
Small	Lille nodestørrelse
Medium	Mellem nodestørrelse
Large	Stor nodestørrelse
XLarge	XLarge-nodestørrelse
XXLarge	XXLarge-nodestørrelse