Workspace Settings - Get Spark Settings

Servicio:: Spark

Versión de la API:: v1

Obtiene la configuración de Spark del área de trabajo.

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/settings

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	WorkspaceSparkSettings	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

WorkspaceSparkSettings

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

Get workspace Spark settings example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

Respuesta de muestra

status code:: 200

{
  "automaticLog": {
    "enabled": true
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": true,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": true,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 2,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Definiciones

Nombre	Description
AutomaticLogProperties	Propiedades automáticas del registro.
CustomPoolType	Tipo de grupo personalizado. Se pueden agregar tipos de `CustomPoolType` adicionales a lo largo del tiempo.
EnvironmentProperties	Propiedades de un entorno.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
HighConcurrencyProperties	Propiedades de simultaneidad alta.
InstancePool	El grupo de instancias.
PoolProperties	Propiedades de un grupo
SparkJobsProperties	Propiedades de un trabajo de Spark.
StarterPoolProperties	Grupo de inicio personalizado.
WorkspaceSparkSettings	Configuración de Spark del área de trabajo.

AutomaticLogProperties

Objeto

Propiedades automáticas del registro.

Nombre	Tipo	Description
enabled	boolean	Estado del registro automático. False: deshabilitado, true: habilitado.

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

EnvironmentProperties

Objeto

Propiedades de un entorno.

Nombre	Tipo	Description
name	string	Nombre del entorno predeterminado. Cadena vacía que indica que no hay ningún entorno predeterminado del área de trabajo.
runtimeVersion	string	versión de runtime. Por ejemplo: 1.3

ErrorRelatedResource

Objeto

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

Objeto

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.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
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 (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

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.

HighConcurrencyProperties

Objeto

Propiedades de simultaneidad alta.

Nombre	Tipo	Description
notebookInteractiveRunEnabled	boolean	Estado de la alta simultaneidad para la ejecución interactiva del cuaderno. False: deshabilitado, true: habilitado.
notebookPipelineRunEnabled	boolean	Estado de la alta simultaneidad para la ejecución de la canalización de cuadernos. False: deshabilitado, true: habilitado.

InstancePool

Objeto

El grupo de instancias.

Nombre	Tipo	Description
id	string (uuid)	Identificador del grupo de instancias.
name	string	Nombre del grupo de instancias.
type	CustomPoolType	Tipo de grupo de instancias.

PoolProperties

Objeto

Propiedades de un grupo

Nombre	Tipo	Description
customizeComputeEnabled	boolean	Personalice las configuraciones de proceso para los elementos. False: deshabilitado, true: habilitado.
defaultPool	InstancePool	Grupo predeterminado para el área de trabajo. Debe ser un nombre de grupo personalizado válido. "Grupo de inicio" significa usar el grupo de inicio.
starterPool	StarterPoolProperties	Personalice el grupo de inicio. Para obtener más información sobre cómo configurar el grupo de inicio, consulte configuración del grupo de inicio.

SparkJobsProperties

Objeto

Propiedades de un trabajo de Spark.

Nombre	Tipo	Description
conservativeJobAdmissionEnabled	boolean	Reserve los núcleos máximos para trabajos activos de Spark. Cuando esta configuración está habilitada, la capacidad de Fabric reserva el número máximo de núcleos necesarios para los trabajos activos de Spark, lo que garantiza la confiabilidad del trabajo asegurándose de que los núcleos están disponibles si un trabajo se escala verticalmente. Cuando esta configuración está deshabilitada, los trabajos se inician en función del número mínimo de núcleos necesarios, lo que permite que se ejecuten más trabajos al mismo tiempo. Para obtener más información, consulte de admisión y administración de trabajos. False: deshabilitado, true: habilitado.
sessionTimeoutInMinutes	integer (int32) minimum: 1 maximum: 20160	Hora de finalizar las sesiones inactivas de Spark. El máximo es de 14 días.

StarterPoolProperties

Objeto

Grupo de inicio personalizado.

Nombre	Tipo	Description
maxExecutors	integer (int32) minimum: 1	Número máximo de ejecutores.
maxNodeCount	integer (int32) minimum: 1	Número máximo de nodos.

WorkspaceSparkSettings

Objeto

Configuración de Spark del área de trabajo.

Nombre	Tipo	Description
automaticLog	AutomaticLogProperties	Configuración automática del registro.
environment	EnvironmentProperties	Configuración del entorno.
highConcurrency	HighConcurrencyProperties	Configuración de simultaneidad alta.
job	SparkJobsProperties	Configuración de administración de trabajos.
pool	PoolProperties	Configuración del grupo.