Custom Pools - Create Workspace Custom Pool

Usługa:

Spark

Wersja interfejsu API:

v1

Utwórz pulę niestandardową.

Uprawnienia

Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

Wymagane zakresy delegowane

Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
autoScale	True	AutoScaleProperties	Autoskalowanie.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
name	True	string	Nazwa puli niestandardowej. Nazwa musi mieć długość od 1 do 64 znaków i musi zawierać tylko litery, cyfry, kreski, podkreślenia i spacje. Nazwy puli niestandardowej muszą być unikatowe w obszarze roboczym. "Pula początkowa" to zarezerwowana nazwa puli niestandardowej.
nodeFamily	True	NodeFamily	Rodzina węzłów.
nodeSize	True	NodeSize	Rozmiar węzła.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	CustomPool	Żądanie zostało ukończone pomyślnie. Nagłówki Location: string
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Przykłady

Create custom pool example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
AutoScaleProperties	Właściwości autoskaluj.
CreateCustomPoolRequest	Utwórz ładunek żądania puli niestandardowej.
CustomPool	Pula niestandardowa.
CustomPoolType	Typ puli niestandardowej. Dodatkowe typy CustomPoolType można dodawać w czasie.
DynamicExecutorAllocationProperties	Dynamiczne zalety alokacji funkcji wykonawczej.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
NodeFamily	Rodzina węzłów. Dodatkowe typy NodeFamily można dodawać w czasie.
NodeSize	rozmiar węzła. Dodatkowe typy NodeSize można dodawać w czasie.

AutoScaleProperties

Objekt

Właściwości autoskaluj.

Nazwa	Typ	Opis
enabled	boolean	Stan automatycznego skalowania. Fałsz — wyłączone, true — włączone.
maxNodeCount	integer (int32) minimum: 1	Maksymalna liczba węzłów.
minNodeCount	integer (int32) minimum: 1	Minimalna liczba węzłów.

CreateCustomPoolRequest

Objekt

Utwórz ładunek żądania puli niestandardowej.

Nazwa	Typ	Opis
autoScale	AutoScaleProperties	Autoskalowanie.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
name	string	Nazwa puli niestandardowej. Nazwa musi mieć długość od 1 do 64 znaków i musi zawierać tylko litery, cyfry, kreski, podkreślenia i spacje. Nazwy puli niestandardowej muszą być unikatowe w obszarze roboczym. "Pula początkowa" to zarezerwowana nazwa puli niestandardowej.
nodeFamily	NodeFamily	Rodzina węzłów.
nodeSize	NodeSize	Rozmiar węzła.

CustomPool

Objekt

Pula niestandardowa.

Nazwa	Typ	Opis
autoScale	AutoScaleProperties	Autoskalowanie.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokacja funkcji wykonawczej dynamicznej.
id	string (uuid)	Identyfikator puli niestandardowej.
name	string	Nazwa puli niestandardowej.
nodeFamily	NodeFamily	Rodzina węzłów.
nodeSize	NodeSize	Rozmiar węzła.
type	CustomPoolType	Typ puli niestandardowej.

CustomPoolType

Wyliczanie

Typ puli niestandardowej. Dodatkowe typy CustomPoolType można dodawać w czasie.

Wartość	Opis
Capacity	Pula niestandardowa na poziomie pojemności
Workspace	Pula niestandardowa na poziomie obszaru roboczego

DynamicExecutorAllocationProperties

Objekt

Dynamiczne zalety alokacji funkcji wykonawczej.

Nazwa	Typ	Opis
enabled	boolean	Stan alokacji funkcji wykonawczej dynamicznej. Fałsz — wyłączone, true — włączone.
maxExecutors	integer (int32) minimum: 1	Maksymalna liczba funkcji wykonawczych.
minExecutors	integer (int32) minimum: 1	Minimalne funkcje wykonawcze.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

NodeFamily

Wyliczanie

Rodzina węzłów. Dodatkowe typy NodeFamily można dodawać w czasie.

Wartość	Opis
MemoryOptimized	Zoptymalizowane pod kątem pamięci

NodeSize

Wyliczanie

rozmiar węzła. Dodatkowe typy NodeSize można dodawać w czasie.

Wartość	Opis
Large	Duży rozmiar węzła
Medium	Średni rozmiar węzła
Small	Mały rozmiar węzła
XLarge	Rozmiar węzła XLarge
XXLarge	Rozmiar węzła XXLarge