Partilhar via

Custom Pools - Create Workspace Custom Pool

Serviço:
Spark
Versão da API:
v1

Crie um pool personalizado.

Permissões

O chamador deve ter função de administrador espaço de trabalho.

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
da entidade de serviço e identidades gerenciadas Sim

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Name Necessário Tipo Description
autoScale True

AutoScaleProperties

Dimensionamento Automático.
dynamicExecutorAllocation True

DynamicExecutorAllocationProperties

Alocação dinâmica do executor.
name True

string

Nome do pool personalizado.
O nome deve ter entre 1 e 64 caracteres e deve conter apenas letras, números, traços, sublinhados e espaços.
Os nomes de pool personalizados devem ser exclusivos dentro do espaço de trabalho.
"Starter Pool" é um nome de pool personalizado reservado.
nodeFamily True

NodeFamily

Família de nós.
nodeSize True

NodeSize

Tamanho do nó.

Respostas

Name Tipo Description
201 Created

CustomPool

Pedido concluído com sucesso.

Cabeçalhos

Location: string
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

Exemplos

Create custom pool example

Pedido de amostra

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

Resposta da amostra

Código de estado:
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
  }
}

Definições

Name Description
AutoScaleProperties

Propriedades de dimensionamento automático.
CreateCustomPoolRequest

Crie uma carga útil de solicitação de pool personalizada.
CustomPool

Piscina personalizada.
CustomPoolType

Tipo de pool personalizado. Tipos de CustomPoolType adicionais podem ser adicionados ao longo do tempo.
DynamicExecutorAllocationProperties

Proerties de alocação de executor dinâmico.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
NodeFamily

Família de nós. Tipos de NodeFamily adicionais podem ser adicionados ao longo do tempo.
NodeSize

Tamanho do nó. Tipos de NodeSize adicionais podem ser adicionados ao longo do tempo.

AutoScaleProperties

Object

Propriedades de dimensionamento automático.

Name Tipo Description
enabled

boolean

O status da escala automática. Falso - Desativado, verdadeiro - Ativado.
maxNodeCount

integer (int32)

minimum: 1

A contagem máxima de nós.
minNodeCount

integer (int32)

minimum: 1

A contagem mínima de nós.

CreateCustomPoolRequest

Object

Crie uma carga útil de solicitação de pool personalizada.

Name Tipo Description
autoScale

AutoScaleProperties

Dimensionamento Automático.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Alocação dinâmica do executor.
name

string

Nome do pool personalizado.
O nome deve ter entre 1 e 64 caracteres e deve conter apenas letras, números, traços, sublinhados e espaços.
Os nomes de pool personalizados devem ser exclusivos dentro do espaço de trabalho.
"Starter Pool" é um nome de pool personalizado reservado.
nodeFamily

NodeFamily

Família de nós.
nodeSize

NodeSize

Tamanho do nó.

CustomPool

Object

Piscina personalizada.

Name Tipo Description
autoScale

AutoScaleProperties

Dimensionamento Automático.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Alocação dinâmica do executor.
id

string (uuid)

ID do pool personalizado.
name

string

Nome do pool personalizado.
nodeFamily

NodeFamily

Família de nós.
nodeSize

NodeSize

Tamanho do nó.
type

CustomPoolType

Tipo de pool personalizado.

CustomPoolType

Enumeração

Tipo de pool personalizado. Tipos de CustomPoolType adicionais podem ser adicionados ao longo do tempo.

Valor Description
Workspace

Pool personalizado no nível do espaço de trabalho
Capacity

Pool personalizado de nível de capacidade

DynamicExecutorAllocationProperties

Object

Proerties de alocação de executor dinâmico.

Name Tipo Description
enabled

boolean

O status da alocação do executor dinâmico. Falso - Desativado, verdadeiro - Ativado.
maxExecutors

integer (int32)

minimum: 1

Os executores máximos.
minExecutors

integer (int32)

minimum: 1

Os executores mínimos.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

NodeFamily

Enumeração

Família de nós. Tipos de NodeFamily adicionais podem ser adicionados ao longo do tempo.

Valor Description
MemoryOptimized

Memória otimizada

NodeSize

Enumeração

Tamanho do nó. Tipos de NodeSize adicionais podem ser adicionados ao longo do tempo.

Valor Description
Small

Tamanho pequeno do nó
Medium

Tamanho médio do nó
Large

Tamanho grande do nó
XLarge

Tamanho do nó XLarge
XXLarge

Tamanho do nó XXLarge