Custom Pools - Create Workspace Custom Pool

Service:

Spark

API-versie:

v1

Aangepaste pool maken.

Machtigingen

De aanroeper moet beheerdersrol werkruimte hebben.

Vereiste gedelegeerde bereiken

Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

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

Identiteit	Ondersteuning
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

gebruikersinterface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

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	CustomPool	De aanvraag is voltooid. Kopteksten Location: string
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/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
  }
}

Voorbeeldrespons

Statuscode:

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

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	Het foutbericht.
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

Inventarisatie

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

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

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

NodeFamily

Inventarisatie

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

Waarde	Description
MemoryOptimized	Geoptimaliseerd voor geheugen

NodeSize

Inventarisatie

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

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