Custom Pools - Update Workspace Custom Pool

Serviço:: Spark

Versão da API:: v1

Atualize o pool personalizado.

Permissões

O chamador deve ter função de administrador workspace.

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

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

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
poolId	path	True	string (uuid)	A ID do pool personalizado.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

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ó.

Respostas

Nome	Tipo	Description
200 OK	CustomPool	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

200 OK

CustomPool

Solicitação concluída com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Update custom pool example

Solicitação de exemplo

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

{
  "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:: 200

{
  "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

Nome	Description
AutoScaleProperties	Propriedades de dimensionamento automático.
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 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.
UpdateCustomPoolRequest	Atualizar o conteúdo da solicitação do pool personalizado.

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.

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 de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida 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.
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	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

UpdateCustomPoolRequest

Objeto

Atualizar o conteúdo da solicitação do 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ó.

Compartilhar via

Custom Pools - Update Workspace Custom Pool

Permissões

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interface

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Update custom pool example

Solicitação de exemplo

Resposta de exemplo

Definições

AutoScaleProperties

CustomPool

CustomPoolType

DynamicExecutorAllocationProperties

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NodeFamily

NodeSize

UpdateCustomPoolRequest