Поделиться через

Custom Pools - Create Workspace Custom Pool

Служба:
Spark
Версия API:
v1

Создание настраиваемого пула.

Разрешения

Вызывающий объект должен иметь роль администратора рабочей области.

Обязательные делегированные области

Workspace.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Идентичность Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
autoScale True

AutoScaleProperties

Автомасштабирование.
dynamicExecutorAllocation True

DynamicExecutorAllocationProperties

Динамическое выделение исполнителя.
name True

string

Имя настраиваемого пула.
Имя должно быть от 1 до 64 символов длиной и должно содержать только буквы, цифры, дефисы, подчеркивания и пробелы.
Имена настраиваемых пулов должны быть уникальными в рабочей области.
"Начальный пул" — это зарезервированное имя настраиваемого пула.
nodeFamily True

NodeFamily

Семейство узлов.
nodeSize True

NodeSize

Размер узла.

Ответы

Имя Тип Описание
201 Created

CustomPool

Запрос успешно завершен.

Заголовки

Location: string
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • UnknownError — произошла ошибка.

Примеры

Create custom pool example

Образец запроса

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

Пример ответа

Код состояния:
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
  }
}

Определения

Имя Описание
AutoScaleProperties

Свойства автомасштабирования.
CreateCustomPoolRequest

Создайте полезные данные запроса настраиваемого пула.
CustomPool

Пользовательский пул.
CustomPoolType

Тип настраиваемого пула. С течением времени могут добавляться дополнительные CustomPoolType типы.
DynamicExecutorAllocationProperties

Динамические преимущества выделения исполнителя.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
NodeFamily

Семейство узлов. С течением времени могут добавляться дополнительные NodeFamily типы.
NodeSize

размер узла. С течением времени могут добавляться дополнительные NodeSize типы.

AutoScaleProperties

Object

Свойства автомасштабирования.

Имя Тип Описание
enabled

boolean

Состояние автомасштабирования. False — отключено, true — включено.
maxNodeCount

integer (int32)

minimum: 1

Максимальное число узлов.
minNodeCount

integer (int32)

minimum: 1

Минимальное число узлов.

CreateCustomPoolRequest

Object

Создайте полезные данные запроса настраиваемого пула.

Имя Тип Описание
autoScale

AutoScaleProperties

Автомасштабирование.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Динамическое выделение исполнителя.
name

string

Имя настраиваемого пула.
Имя должно быть от 1 до 64 символов длиной и должно содержать только буквы, цифры, дефисы, подчеркивания и пробелы.
Имена настраиваемых пулов должны быть уникальными в рабочей области.
"Начальный пул" — это зарезервированное имя настраиваемого пула.
nodeFamily

NodeFamily

Семейство узлов.
nodeSize

NodeSize

Размер узла.

CustomPool

Object

Пользовательский пул.

Имя Тип Описание
autoScale

AutoScaleProperties

Автомасштабирование.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Динамическое выделение исполнителя.
id

string (uuid)

Пользовательский идентификатор пула.
name

string

Имя настраиваемого пула.
nodeFamily

NodeFamily

Семейство узлов.
nodeSize

NodeSize

Размер узла.
type

CustomPoolType

Тип настраиваемого пула.

CustomPoolType

Перечисление

Тип настраиваемого пула. С течением времени могут добавляться дополнительные CustomPoolType типы.

Значение Описание
Workspace

Настраиваемый пул уровня рабочей области
Capacity

Настраиваемый пул уровня емкости

DynamicExecutorAllocationProperties

Object

Динамические преимущества выделения исполнителя.

Имя Тип Описание
enabled

boolean

Состояние динамического выделения исполнителя. False — отключено, true — включено.
maxExecutors

integer (int32)

minimum: 1

Максимальное число исполнителей.
minExecutors

integer (int32)

minimum: 1

Минимальные исполнители.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

NodeFamily

Перечисление

Семейство узлов. С течением времени могут добавляться дополнительные NodeFamily типы.

Значение Описание
MemoryOptimized

Оптимизировано использование памяти

NodeSize

Перечисление

размер узла. С течением времени могут добавляться дополнительные NodeSize типы.

Значение Описание
Small

Небольшой размер узла
Medium

Средний размер узла
Large

Размер большого узла
XLarge

Размер узла XLarge
XXLarge

Размер узла XXLarge