Custom Pools - Create Workspace Custom Pool

Palvelu:: Spark

Ohjelmointirajapinnan versio:: v1

Luo mukautettu varanto.

Käyttöoikeudet

Soittajalla on oltava järjestelmänvalvojan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Käyttäjätiedot	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Liittymä

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
autoScale	True	AutoScaleProperties	Automaattinen skaalaaminen:
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynaamisen suoritettavan tiedoston kohdistus.
name	True	string	Mukautetun varannon nimi. Nimen on oltava 1–64 merkkiä pitkä, ja sen on sisällettävä vain kirjaimia, numeroita, ajatusviivoja, alaviivoja ja välilyöntejä. Mukautettujen varannon nimien on oltava yksilöllisiä työtilassa. Aloitussarja on varattu mukautettu varannon nimi.
nodeFamily	True	NodeFamily	Noden perhe.
nodeSize	True	NodeSize	Solmun koko.

Vastaukset

Nimi Tyyppi Kuvaus

201 Created

Nimi	Tyyppi	Kuvaus
201 Created	CustomPool	Pyynnön valmistuttua. Otsikot Location: string
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: UnknownError – Ilmeni virhe.

CustomPool

Pyynnön valmistuttua.

Otsikot

Location: string

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

UnknownError – Ilmeni virhe.

Esimerkit

Create custom pool example

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi	Kuvaus
AutoScaleProperties	Automaattinen skaalauksen ominaisuudet.
CreateCustomPoolRequest	Luo mukautettuja varannon pyyntökuormituksia.
CustomPool	Mukautettu varanto.
CustomPoolType	Mukautettu varannon tyyppi. Muita `CustomPoolType` tyyppejä voidaan lisätä ajan kuluessa.
DynamicExecutorAllocationProperties	Dynaamisen suoritettavan tiedoston kohdistuksen proertiiveja.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
NodeFamily	Noden perhe. Muita `NodeFamily` tyyppejä voidaan lisätä ajan kuluessa.
NodeSize	Solmun koko. Muita `NodeSize` tyyppejä voidaan lisätä ajan kuluessa.

AutoScaleProperties

Kohde

Automaattinen skaalauksen ominaisuudet.

Nimi	Tyyppi	Kuvaus
enabled	boolean	Automaattisen skaalauksen tila. False – Ei käytössä, true – Käytössä.
maxNodeCount	integer (int32) minimum: 1	Solmujen enimmäismäärä.
minNodeCount	integer (int32) minimum: 1	Solmujen vähimmäismäärä.

CreateCustomPoolRequest

Kohde

Luo mukautettuja varannon pyyntökuormituksia.

Nimi	Tyyppi	Kuvaus
autoScale	AutoScaleProperties	Automaattinen skaalaaminen:
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynaamisen suoritettavan tiedoston kohdistus.
name	string	Mukautetun varannon nimi. Nimen on oltava 1–64 merkkiä pitkä, ja sen on sisällettävä vain kirjaimia, numeroita, ajatusviivoja, alaviivoja ja välilyöntejä. Mukautettujen varannon nimien on oltava yksilöllisiä työtilassa. Aloitussarja on varattu mukautettu varannon nimi.
nodeFamily	NodeFamily	Noden perhe.
nodeSize	NodeSize	Solmun koko.

CustomPool

Kohde

Mukautettu varanto.

Nimi	Tyyppi	Kuvaus
autoScale	AutoScaleProperties	Automaattinen skaalaaminen:
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynaamisen suoritettavan tiedoston kohdistus.
id	string (uuid)	Mukautetun varannon tunnus.
name	string	Mukautetun varannon nimi.
nodeFamily	NodeFamily	Noden perhe.
nodeSize	NodeSize	Solmun koko.
type	CustomPoolType	Mukautettu varannon tyyppi.

CustomPoolType

Luettelointi

Mukautettu varannon tyyppi. Muita CustomPoolType tyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Workspace	Työtilatason mukautettu varanto
Capacity	Kapasiteettitason mukautettu varanto

DynamicExecutorAllocationProperties

Kohde

Dynaamisen suoritettavan tiedoston kohdistuksen proertiiveja.

Nimi	Tyyppi	Kuvaus
enabled	boolean	Dynaamisen suoritettavan tiedoston kohdistuksen tila. False – Ei käytössä, true – Käytössä.
maxExecutors	integer (int32) minimum: 1	Suoritettavien suoritusten enimmäismäärä.
minExecutors	integer (int32) minimum: 1	Suoritettavat vähimmäistiedostot.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

NodeFamily

Luettelointi

Noden perhe. Muita NodeFamily tyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
MemoryOptimized	Optimoitu muisti

NodeSize

Luettelointi

Solmun koko. Muita NodeSize tyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Small	Pieni solmukoko
Medium	Keskitasoinen solmun koko
Large	Suuren solmun koko
XLarge	XLarge-solmun koko
XXLarge	XXLarge-solmun koko