Custom Pools - CreateCapacityCustomPool (beta)

Serviço:: Spark

Versão da API:: v1

Criar pool personalizado.

Note

Essa API faz parte de uma versão Beta e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. Ao chamar essa API, os chamadores devem especificar true como o valor do parâmetro betade consulta.

Permissions

O chamador deve ser um administrador de capacidade.

Escopos delegados necessários

Capacity.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Suporte
Usuário	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interface

POST https://api.fabric.microsoft.com/v1/capacities/{capacityId}/spark/pools?beta={beta}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
capacityId	path	True	string (uuid)	A ID da capacidade.
beta	query	True	boolean	Esse parâmetro necessário deve ser definido para `true` acessar essa API, que está atualmente em beta.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
autoScale	True	AutoScaleProperties	Dimensionamento automático.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Alocação de executor dinâmico.
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 no workspace. "Pool inicial" é um nome de pool personalizado reservado.
nodeFamily	True	NodeFamily	Família de nós.
nodeSize	True	NodeSize	Tamanho do nó.

Respostas

Nome Tipo Description

201 Created

Nome	Tipo	Description
201 Created	CustomPool	Solicitação concluída com êxito. Cabeçalhos: Localização`string` - A URL do pool recém-criado.
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

CustomPool

Solicitação concluída com êxito.

Cabeçalhos:

Localizaçãostring - A URL do pool recém-criado.

429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Create custom pool example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools?beta=True

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Resposta de exemplo

Código de status:: 201

Location: https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Capacity",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Definições

Nome	Description
AutoScaleProperties	Propriedades de dimensionamento automático.
CreateCustomPoolRequest	Criar conteúdo de solicitação de pool personalizado.
CustomPool	Pool personalizado.
CustomPoolType	Tipo de pool personalizado. Tipos de `CustomPoolType` adicionais podem ser adicionados ao longo do tempo.
DynamicExecutorAllocationProperties	Proeridades de alocação do executor dinâmico.
ErrorRelatedResource	O objeto relacionado ao erro nos detalhes do recurso.
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

Objeto

Propriedades de dimensionamento automático.

Nome	Tipo	Description
enabled	boolean	O status da escala automática. False – Desabilitado, verdadeiro – Habilitado.
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

Objeto

Criar conteúdo de solicitação de pool personalizado.

Nome	Tipo	Description
autoScale	AutoScaleProperties	Dimensionamento automático.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alocação de executor dinâmico.
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 no workspace. "Pool inicial" é um nome de pool personalizado reservado.
nodeFamily	NodeFamily	Família de nós.
nodeSize	NodeSize	Tamanho do nó.

CustomPool

Objeto

Pool personalizado.

Nome	Tipo	Description
autoScale	AutoScaleProperties	Dimensionamento automático.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alocação de executor dinâmico.
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 workspace
Capacity	Pool personalizado no nível de capacidade

DynamicExecutorAllocationProperties

Objeto

Proeridades de alocação do executor dinâmico.

Nome	Tipo	Description
enabled	boolean	O status da alocação do executor dinâmico. False – Desabilitado, verdadeiro – Habilitado.
maxExecutors	integer (int32) minimum: 1	O máximo de executores.
minExecutors	integer (int32) minimum: 1	Os executores mínimos.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome	Tipo	Description
resourceId	string	O identificador do recurso envolvido no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado 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