Big Data Pools - Create Or Update

Servicio:: Synapse

Versión de la API:: 2021-06-01

Cree un grupo de macrodatos.
Cree un nuevo grupo de macrodatos.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}?api-version=2021-06-01

Con parámetros opcionales:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}?api-version=2021-06-01&force={force}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
bigDataPoolName	path	True	string	Nombre del grupo de macrodatos
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
force	query		boolean	Si se deben detener los trabajos en ejecución en el grupo de macrodatos

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
properties.autoPause		AutoPauseProperties	Propiedades de pausa automática del grupo de Spark Propiedades de pausa automática
properties.autoScale		AutoScaleProperties	Propiedades de escalado automático del grupo de Spark Propiedades de escalado automático
properties.cacheSize		integer (int32)	Tamaño de caché
properties.customLibraries		LibraryInfo[]	Lista de bibliotecas o paquetes personalizados asociados al grupo de Spark.
properties.defaultSparkLogFolder		string	Carpeta predeterminada donde se escribirán los registros de Spark.
properties.dynamicExecutorAllocation		DynamicExecutorAllocation	Asignación dinámica del ejecutor
properties.isAutotuneEnabled		boolean	Habilitar Autotune Indica si se requiere o no el ajuste automático.
properties.isComputeIsolationEnabled		boolean	Indica si se requiere o no el aislamiento de proceso.
properties.libraryRequirements		LibraryRequirements	Requisitos de versión de la biblioteca de grupos de Spark Requisitos de la versión de la biblioteca
properties.nodeCount		integer (int32)	Número de nodos del grupo de macrodatos.
properties.nodeSize		NodeSize	Nivel de potencia de proceso que tiene cada nodo del grupo de macrodatos.
properties.nodeSizeFamily		NodeSizeFamily	Tipo de nodos que proporciona el grupo de macrodatos.
properties.provisioningState		string	Estado del grupo de macrodatos.
properties.sessionLevelPackagesEnabled		boolean	Indica si los paquetes de nivel de sesión están habilitados.
properties.sparkConfigProperties		SparkConfigProperties	Propiedades de configuración del grupo de Spark Archivo de configuración de Spark para especificar propiedades adicionales
properties.sparkEventsFolder		string	Carpeta de eventos de Spark
properties.sparkVersion		string	Versión de Apache Spark.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	BigDataPoolResourceInfo	De acuerdo
202 Accepted	BigDataPoolResourceInfo
Other Status Codes	ErrorResponse

Ejemplos

Create or update a Big Data pool

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool?api-version=2021-06-01

{
  "tags": {
    "key": "value"
  },
  "location": "West US 2",
  "properties": {
    "sparkVersion": "3.3",
    "nodeCount": 4,
    "nodeSize": "Medium",
    "nodeSizeFamily": "MemoryOptimized",
    "autoScale": {
      "enabled": true,
      "minNodeCount": 3,
      "maxNodeCount": 50
    },
    "autoPause": {
      "enabled": true,
      "delayInMinutes": 15
    },
    "sparkEventsFolder": "/events",
    "libraryRequirements": {
      "content": "",
      "filename": "requirements.txt"
    },
    "defaultSparkLogFolder": "/logs",
    "isAutotuneEnabled": false
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool",
  "type": "Microsoft.Synapse/workspaces/bigDataPools",
  "location": "West US 2",
  "name": "ExamplePool",
  "tags": {
    "key": "value"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "sparkVersion": "3.3",
    "nodeCount": 4,
    "nodeSize": "Medium",
    "nodeSizeFamily": "MemoryOptimized",
    "autoScale": {
      "enabled": true,
      "minNodeCount": 3,
      "maxNodeCount": 50
    },
    "autoPause": {
      "enabled": true,
      "delayInMinutes": 15
    },
    "creationDate": "1970-01-01T00:00:00Z",
    "sparkEventsFolder": "/events",
    "libraryRequirements": {
      "time": "1970-01-01T00:00:00Z",
      "content": "",
      "filename": "requirements.txt"
    },
    "defaultSparkLogFolder": "/logs",
    "lastSucceededTimestamp": "1970-01-01T10:00:00Z",
    "isAutotuneEnabled": false
  }
}

status code:: 202

{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool",
  "type": "Microsoft.Synapse/workspaces/bigDataPools",
  "location": "West US 2",
  "name": "ExamplePool",
  "tags": {
    "key": "value"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "sparkVersion": "3.3",
    "nodeCount": 4,
    "nodeSize": "Medium",
    "nodeSizeFamily": "MemoryOptimized",
    "autoScale": {
      "enabled": true,
      "minNodeCount": 3,
      "maxNodeCount": 50
    },
    "autoPause": {
      "enabled": true,
      "delayInMinutes": 15
    },
    "creationDate": "1970-01-01T00:00:00Z",
    "sparkEventsFolder": "/events",
    "libraryRequirements": {
      "time": "1970-01-01T00:00:00Z",
      "content": "",
      "filename": "requirements.txt"
    },
    "defaultSparkLogFolder": "/logs",
    "isAutotuneEnabled": false
  }
}

status code:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definiciones

Nombre	Description
AutoPauseProperties	Propiedades de pausa automática del grupo de Spark
AutoScaleProperties	Propiedades de escalado automático del grupo de Spark
BigDataPoolResourceInfo	Grupo de macrodatos
ConfigurationType	Tipo del archivo de propiedades de configuración de Spark.
DynamicExecutorAllocation	Propiedades de asignación dinámicas del ejecutor
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LibraryInfo	Información sobre una biblioteca o paquete creado en el nivel de área de trabajo.
LibraryRequirements	Requisitos de versión de la biblioteca de grupos de Spark
NodeSize	Nivel de potencia de proceso que tiene cada nodo del grupo de macrodatos.
NodeSizeFamily	Tipo de nodos que proporciona el grupo de macrodatos.
SparkConfigProperties	Propiedades de configuración del grupo de Spark

AutoPauseProperties

Object

Propiedades de pausa automática del grupo de Spark

Nombre	Tipo	Description
delayInMinutes	integer (int32)	Número de minutos de tiempo de inactividad antes de que el grupo de macrodatos se pause automáticamente.
enabled	boolean	Indica si la pausa automática está habilitada para el grupo de macrodatos.

AutoScaleProperties

Object

Propiedades de escalado automático del grupo de Spark

Nombre	Tipo	Description
enabled	boolean	Indica si el escalado automático está habilitado para el grupo de macrodatos.
maxNodeCount	integer (int32)	El número máximo de nodos que puede admitir el grupo de macrodatos.
minNodeCount	integer (int32)	El número mínimo de nodos que puede admitir el grupo de macrodatos.

BigDataPoolResourceInfo

Object

Grupo de macrodatos

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.autoPause	AutoPauseProperties	Propiedades de pausa automática del grupo de Spark Propiedades de pausa automática
properties.autoScale	AutoScaleProperties	Propiedades de escalado automático del grupo de Spark Propiedades de escalado automático
properties.cacheSize	integer (int32)	Tamaño de caché
properties.creationDate	string (date-time)	Hora en que se creó el grupo de macrodatos.
properties.customLibraries	LibraryInfo[]	Lista de bibliotecas o paquetes personalizados asociados al grupo de Spark.
properties.defaultSparkLogFolder	string	Carpeta predeterminada donde se escribirán los registros de Spark.
properties.dynamicExecutorAllocation	DynamicExecutorAllocation	Asignación dinámica del ejecutor
properties.isAutotuneEnabled	boolean	Habilitar Autotune Indica si se requiere o no el ajuste automático.
properties.isComputeIsolationEnabled	boolean	Indica si se requiere o no el aislamiento de proceso.
properties.lastSucceededTimestamp	string (date-time)	Hora en que el grupo de macrodatos se actualizó correctamente.
properties.libraryRequirements	LibraryRequirements	Requisitos de versión de la biblioteca de grupos de Spark Requisitos de la versión de la biblioteca
properties.nodeCount	integer (int32)	Número de nodos del grupo de macrodatos.
properties.nodeSize	NodeSize	Nivel de potencia de proceso que tiene cada nodo del grupo de macrodatos.
properties.nodeSizeFamily	NodeSizeFamily	Tipo de nodos que proporciona el grupo de macrodatos.
properties.provisioningState	string	Estado del grupo de macrodatos.
properties.sessionLevelPackagesEnabled	boolean	Indica si los paquetes de nivel de sesión están habilitados.
properties.sparkConfigProperties	SparkConfigProperties	Propiedades de configuración del grupo de Spark Archivo de configuración de Spark para especificar propiedades adicionales
properties.sparkEventsFolder	string	Carpeta de eventos de Spark
properties.sparkVersion	string	Versión de Apache Spark.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ConfigurationType

Enumeración

Tipo del archivo de propiedades de configuración de Spark.

Valor	Description
File
Artifact

DynamicExecutorAllocation

Object

Propiedades de asignación dinámicas del ejecutor

Nombre	Tipo	Description
enabled	boolean	Indica si la asignación dinámica del ejecutor está habilitada o no.
maxExecutors	integer (int32)	Número máximo de ejecutores a la que se ha unido
minExecutors	integer (int32)	Número mínimo de ejecutores al que se ha unido

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LibraryInfo

Object

Información sobre una biblioteca o paquete creado en el nivel de área de trabajo.

Nombre	Tipo	Description
containerName	string	Nombre del contenedor de blobs de almacenamiento.
creatorId	string	Identificador de creador de la biblioteca o paquete.
name	string	Nombre de la biblioteca.
path	string	Ruta de acceso del blob de almacenamiento de la biblioteca.
provisioningStatus	string	Estado de aprovisionamiento de la biblioteca o paquete.
type	string	Tipo de la biblioteca.
uploadedTimestamp	string (date-time)	La última hora de actualización de la biblioteca.

LibraryRequirements

Object

Requisitos de versión de la biblioteca de grupos de Spark

Nombre	Tipo	Description
content	string	Requisitos de la biblioteca.
filename	string	Nombre de archivo del archivo de requisitos de la biblioteca.
time	string (date-time)	La última hora de actualización del archivo de requisitos de biblioteca.

NodeSize

Enumeración

Nivel de potencia de proceso que tiene cada nodo del grupo de macrodatos.

Valor	Description
None
Small
Medium
Large
XLarge
XXLarge
XXXLarge

NodeSizeFamily

Enumeración

Tipo de nodos que proporciona el grupo de macrodatos.

Valor	Description
None
MemoryOptimized
HardwareAcceleratedFPGA
HardwareAcceleratedGPU

SparkConfigProperties

Object

Propiedades de configuración del grupo de Spark

Nombre	Tipo	Description
configurationType	ConfigurationType	Tipo del archivo de propiedades de configuración de Spark.
content	string	Propiedades de configuración de Spark.
filename	string	Nombre de archivo del archivo de propiedades de configuración de Spark.
time	string (date-time)	Hora de la última actualización del archivo de propiedades de configuración de Spark.

Compartir a través de

Big Data Pools - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create or update a Big Data pool

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AutoPauseProperties

AutoScaleProperties

BigDataPoolResourceInfo

ConfigurationType

DynamicExecutorAllocation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LibraryInfo

LibraryRequirements

NodeSize

NodeSizeFamily

SparkConfigProperties