Compartir a través de

Custom Pools - Get Workspace Custom Pool

Servicio:
Spark
Versión de la API:
v1

Obtenga un grupo personalizado.

Permisos

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Sí

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
poolId
 path True

string (uuid)

Identificador del grupo personalizado.
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Respuestas

Nombre Tipo Description
200 OK

CustomPool

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • UnknownError: se produjo un error.

Ejemplos

Get custom pool example

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AutoScaleProperties

Propiedades de escalado automático.
CustomPool

Grupo personalizado.
CustomPoolType

Tipo de grupo personalizado. Se pueden agregar tipos de CustomPoolType adicionales a lo largo del tiempo.
DynamicExecutorAllocationProperties

Proerties de asignación del ejecutor dinámico.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
NodeFamily

Familia de nodos. Se pueden agregar tipos de NodeFamily adicionales a lo largo del tiempo.
NodeSize

tamaño del nodo. Se pueden agregar tipos de NodeSize adicionales a lo largo del tiempo.

AutoScaleProperties

Object

Propiedades de escalado automático.

Nombre Tipo Description
enabled

boolean

Estado del escalado automático. False: deshabilitado, true: habilitado.
maxNodeCount

integer (int32)

minimum: 1

Número máximo de nodos.
minNodeCount

integer (int32)

minimum: 1

Número mínimo de nodos.

CustomPool

Object

Grupo personalizado.

Nombre Tipo Description
autoScale

AutoScaleProperties

Escalabilidad automática.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Asignación dinámica del ejecutor.
id

string (uuid)

Identificador de grupo personalizado.
name

string

Nombre del grupo personalizado.
nodeFamily

NodeFamily

Familia de nodos.
nodeSize

NodeSize

Tamaño del nodo.
type

CustomPoolType

Tipo de grupo personalizado.

CustomPoolType

Enumeración

Tipo de grupo personalizado. Se pueden agregar tipos de CustomPoolType adicionales a lo largo del tiempo.

Valor Description
Workspace

Grupo personalizado de nivel de área de trabajo
Capacity

Grupo personalizado de nivel de capacidad

DynamicExecutorAllocationProperties

Object

Proerties de asignación del ejecutor dinámico.

Nombre Tipo Description
enabled

boolean

Estado de la asignación dinámica del ejecutor. False: deshabilitado, true: habilitado.
maxExecutors

integer (int32)

minimum: 1

Ejecutores máximos.
minExecutors

integer (int32)

minimum: 1

Ejecutores mínimos.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

NodeFamily

Enumeración

Familia de nodos. Se pueden agregar tipos de NodeFamily adicionales a lo largo del tiempo.

Valor Description
MemoryOptimized

Optimización de memoria

NodeSize

Enumeración

tamaño del nodo. Se pueden agregar tipos de NodeSize adicionales a lo largo del tiempo.

Valor Description
Small

Tamaño de nodo pequeño
Medium

Tamaño de nodo medio
Large

Tamaño de nodo grande
XLarge

Tamaño del nodo XLarge
XXLarge

Tamaño del nodo XXLarge