Custom Pools - CreateCapacityCustomPool (beta)

Service:: Spark

API-versie:: v1

Aangepaste pool maken.

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. Bij het aanroepen van deze API moeten aanroepers de waarde voor de queryparameter trueopgevenbeta.

Machtigingen

De beller moet een capaciteitsbeheerder zijn.

Vereiste gedelegeerde bevoegdheden

Capacity.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

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

Identity	Support
User	Ja
serviceprincipal en beheerde identiteiten	Ja

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
capacityId	path	True	string (uuid)	De capaciteits-id.
beta	query	True	boolean	Deze vereiste parameter moet worden ingesteld voor `true` toegang tot deze API, die momenteel in bèta is.

Aanvraagbody

Name	Vereist	Type	Description
autoScale	True	AutoScaleProperties	Automatische schaalaanpassing.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynamische uitvoerdertoewijzing.
name	True	string	Naam van aangepaste pool. De naam moet tussen 1 en 64 tekens lang zijn en mag alleen letters, cijfers, streepjes, onderstrepingstekens en spaties bevatten. Aangepaste groepsnamen moeten uniek zijn binnen de werkruimte. Starterspool is een gereserveerde aangepaste poolnaam.
nodeFamily	True	NodeFamily	Knooppuntfamilie.
nodeSize	True	NodeSize	Knooppuntgrootte.

Antwoorden

Name Type Description

201 Created

Name	Type	Description
201 Created	CustomPool	De aanvraag is voltooid. Kopteksten: Locatie`string` - De URL van de zojuist gemaakte pool.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

CustomPool

De aanvraag is voltooid.

Kopteksten:

Locatiestring - De URL van de zojuist gemaakte pool.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.

Voorbeelden

Create custom pool example

Voorbeeldaanvraag

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
  }
}

Voorbeeldrespons

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

Definities

Name	Description
AutoScaleProperties	Eigenschappen voor automatisch schalen.
CreateCustomPoolRequest	Aangepaste nettolading voor poolaanvragen maken.
CustomPool	Aangepaste pool.
CustomPoolType	Aangepast pooltype. Er kunnen in de loop van de tijd extra `CustomPoolType` typen worden toegevoegd.
DynamicExecutorAllocationProperties	Dynamische uitvoerprogrammatoewijzingsproxy's.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	De foutreactie.
ErrorResponseDetails	De details van het foutbericht.
NodeFamily	Knooppuntfamilie. Er kunnen in de loop van de tijd extra `NodeFamily` typen worden toegevoegd.
NodeSize	knooppuntgrootte. Er kunnen in de loop van de tijd extra `NodeSize` typen worden toegevoegd.

AutoScaleProperties

Object

Eigenschappen voor automatisch schalen.

Name	Type	Description
enabled	boolean	De status van de automatische schaal. False - Disabled, true - Enabled.
maxNodeCount	integer (int32) minimum: 1	Het maximumaantal knooppunten.
minNodeCount	integer (int32) minimum: 1	Het minimumaantal knooppunten.

CreateCustomPoolRequest

Object

Aangepaste nettolading voor poolaanvragen maken.

Name	Type	Description
autoScale	AutoScaleProperties	Automatische schaalaanpassing.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische uitvoerdertoewijzing.
name	string	Naam van aangepaste pool. De naam moet tussen 1 en 64 tekens lang zijn en mag alleen letters, cijfers, streepjes, onderstrepingstekens en spaties bevatten. Aangepaste groepsnamen moeten uniek zijn binnen de werkruimte. Starterspool is een gereserveerde aangepaste poolnaam.
nodeFamily	NodeFamily	Knooppuntfamilie.
nodeSize	NodeSize	Knooppuntgrootte.

CustomPool

Object

Aangepaste pool.

Name	Type	Description
autoScale	AutoScaleProperties	Automatische schaalaanpassing.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische uitvoerdertoewijzing.
id	string (uuid)	Aangepaste pool-id.
name	string	Naam van aangepaste pool.
nodeFamily	NodeFamily	Knooppuntfamilie.
nodeSize	NodeSize	Knooppuntgrootte.
type	CustomPoolType	Aangepast pooltype.

CustomPoolType

Opsomming

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

Waarde	Description
Workspace	Aangepaste pool op werkruimteniveau
Capacity	Aangepaste pool op capaciteitsniveau

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	De maximale uitvoerders.
minExecutors	integer (int32) minimum: 1	De minimale uitvoerders.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-ID die betrokken is bij het probleem.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

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.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	Details van de foutgerelateerde resource.
requestId	string (uuid)	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	Details van de foutgerelateerde resource.

NodeFamily

Opsomming

Knooppuntfamilie. Er kunnen in de loop van de tijd extra NodeFamily typen worden toegevoegd.

Waarde	Description
MemoryOptimized	Geoptimaliseerd geheugen

NodeSize

Opsomming

knooppuntgrootte. Er kunnen in de loop van de tijd extra NodeSize typen worden toegevoegd.

Waarde	Description
Small	Kleine knooppuntgrootte
Medium	Gemiddelde knooppuntgrootte
Large	Grote knooppuntgrootte
XLarge	XLarge-knooppuntgrootte
XXLarge	XxLarge-knooppuntgrootte