Big Data Pools - Create Or Update

Serviço:: Synapse

Versão da API:: 2021-06-01

Criar um pool de Big Data.
Crie um novo pool de Big Data.

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

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
bigDataPoolName	path	True	string	Nome do pool de Big Data
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
force	query		boolean	Se deseja interromper trabalhos em execução no pool de Big Data

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
properties.autoPause		AutoPauseProperties	Propriedades de pausa automática do pool do Spark Propriedades de pausa automática
properties.autoScale		AutoScaleProperties	Propriedades de dimensionamento automático do pool do Spark Propriedades de dimensionamento automático
properties.cacheSize		integer (int32)	O tamanho do cache
properties.customLibraries		LibraryInfo[]	Lista de bibliotecas/pacotes personalizados associados ao pool do Spark.
properties.defaultSparkLogFolder		string	A pasta padrão em que os logs do Spark serão gravados.
properties.dynamicExecutorAllocation		DynamicExecutorAllocation	Alocação do Executor Dinâmico
properties.isAutotuneEnabled		boolean	Habilitar o Autotune Se o autotune é necessário ou não.
properties.isComputeIsolationEnabled		boolean	Se o isolamento de computação é necessário ou não.
properties.libraryRequirements		LibraryRequirements	Requisitos de versão da biblioteca do pool do Spark Requisitos de versão da biblioteca
properties.nodeCount		integer (int32)	O número de nós no pool de Big Data.
properties.nodeSize		NodeSize	O nível de poder de computação que cada nó no pool de Big Data tem.
properties.nodeSizeFamily		NodeSizeFamily	O tipo de nós que o pool de Big Data fornece.
properties.provisioningState		string	O estado do pool de Big Data.
properties.sessionLevelPackagesEnabled		boolean	Se os pacotes de nível de sessão estão habilitados.
properties.sparkConfigProperties		SparkConfigProperties	Propriedades de configuração do pool do Spark Arquivo de configuração do Spark para especificar propriedades adicionais
properties.sparkEventsFolder		string	A pasta de eventos do Spark
properties.sparkVersion		string	A versão do Apache Spark.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	BigDataPoolResourceInfo	OKEY
202 Accepted	BigDataPoolResourceInfo
Other Status Codes	ErrorResponse

Exemplos

Create or update a Big Data pool

Solicitação de exemplo

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
  }
}

Resposta de exemplo

Código de status:: 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
  }
}

Código de status:: 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
  }
}

Código de status:: default

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

Definições

Nome	Description
AutoPauseProperties	Propriedades de pausa automática do pool do Spark
AutoScaleProperties	Propriedades de dimensionamento automático do pool do Spark
BigDataPoolResourceInfo	Pool de Big Data
ConfigurationType	O tipo do arquivo de propriedades de configuração do Spark.
DynamicExecutorAllocation	Propriedades de alocação do Executor Dinâmico
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LibraryInfo	Informações sobre uma biblioteca/pacote criado no nível do workspace.
LibraryRequirements	Requisitos de versão da biblioteca do pool do Spark
NodeSize	O nível de poder de computação que cada nó no pool de Big Data tem.
NodeSizeFamily	O tipo de nós que o pool de Big Data fornece.
SparkConfigProperties	Propriedades de configuração do pool do Spark

AutoPauseProperties

Objeto

Propriedades de pausa automática do pool do Spark

Nome	Tipo	Description
delayInMinutes	integer (int32)	Número de minutos de tempo ocioso antes que o pool de Big Data seja pausado automaticamente.
enabled	boolean	Se a pausa automática está habilitada para o pool de Big Data.

AutoScaleProperties

Objeto

Propriedades de dimensionamento automático do pool do Spark

Nome	Tipo	Description
enabled	boolean	Se o dimensionamento automático está habilitado para o pool de Big Data.
maxNodeCount	integer (int32)	O número máximo de nós que o pool de Big Data pode dar suporte.
minNodeCount	integer (int32)	O número mínimo de nós que o pool de Big Data pode dar suporte.

BigDataPoolResourceInfo

Objeto

Pool de Big Data

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.autoPause	AutoPauseProperties	Propriedades de pausa automática do pool do Spark Propriedades de pausa automática
properties.autoScale	AutoScaleProperties	Propriedades de dimensionamento automático do pool do Spark Propriedades de dimensionamento automático
properties.cacheSize	integer (int32)	O tamanho do cache
properties.creationDate	string (date-time)	A hora em que o pool de Big Data foi criado.
properties.customLibraries	LibraryInfo[]	Lista de bibliotecas/pacotes personalizados associados ao pool do Spark.
properties.defaultSparkLogFolder	string	A pasta padrão em que os logs do Spark serão gravados.
properties.dynamicExecutorAllocation	DynamicExecutorAllocation	Alocação do Executor Dinâmico
properties.isAutotuneEnabled	boolean	Habilitar o Autotune Se o autotune é necessário ou não.
properties.isComputeIsolationEnabled	boolean	Se o isolamento de computação é necessário ou não.
properties.lastSucceededTimestamp	string (date-time)	A hora em que o pool de Big Data foi atualizado com êxito.
properties.libraryRequirements	LibraryRequirements	Requisitos de versão da biblioteca do pool do Spark Requisitos de versão da biblioteca
properties.nodeCount	integer (int32)	O número de nós no pool de Big Data.
properties.nodeSize	NodeSize	O nível de poder de computação que cada nó no pool de Big Data tem.
properties.nodeSizeFamily	NodeSizeFamily	O tipo de nós que o pool de Big Data fornece.
properties.provisioningState	string	O estado do pool de Big Data.
properties.sessionLevelPackagesEnabled	boolean	Se os pacotes de nível de sessão estão habilitados.
properties.sparkConfigProperties	SparkConfigProperties	Propriedades de configuração do pool do Spark Arquivo de configuração do Spark para especificar propriedades adicionais
properties.sparkEventsFolder	string	A pasta de eventos do Spark
properties.sparkVersion	string	A versão do Apache Spark.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ConfigurationType

Enumeração

O tipo do arquivo de propriedades de configuração do Spark.

Valor	Description
File
Artifact

DynamicExecutorAllocation

Objeto

Propriedades de alocação do Executor Dinâmico

Nome	Tipo	Description
enabled	boolean	Indica se a Alocação do Executor Dinâmico está habilitada ou não.
maxExecutors	integer (int32)	O número máximo de executores alocados
minExecutors	integer (int32)	O número mínimo de executores alocados

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

LibraryInfo

Objeto

Informações sobre uma biblioteca/pacote criado no nível do workspace.

Nome	Tipo	Description
containerName	string	Nome do contêiner de blob de armazenamento.
creatorId	string	ID do criador da biblioteca/pacote.
name	string	Nome da biblioteca.
path	string	Caminho do blob de armazenamento da biblioteca.
provisioningStatus	string	Status de provisionamento da biblioteca/pacote.
type	string	Tipo da biblioteca.
uploadedTimestamp	string (date-time)	A hora da última atualização da biblioteca.

LibraryRequirements

Objeto

Requisitos de versão da biblioteca do pool do Spark

Nome	Tipo	Description
content	string	Os requisitos da biblioteca.
filename	string	O nome do arquivo de requisitos da biblioteca.
time	string (date-time)	A hora da última atualização do arquivo de requisitos da biblioteca.

NodeSize

Enumeração

O nível de poder de computação que cada nó no pool de Big Data tem.

Valor	Description
None
Small
Medium
Large
XLarge
XXLarge
XXXLarge

NodeSizeFamily

Enumeração

O tipo de nós que o pool de Big Data fornece.

Valor	Description
None
MemoryOptimized
HardwareAcceleratedFPGA
HardwareAcceleratedGPU

SparkConfigProperties

Objeto

Propriedades de configuração do pool do Spark

Nome	Tipo	Description
configurationType	ConfigurationType	O tipo do arquivo de propriedades de configuração do Spark.
content	string	As propriedades de configuração do Spark.
filename	string	O nome do arquivo de propriedades de configuração do Spark.
time	string (date-time)	A hora da última atualização do arquivo de propriedades de configuração do Spark.

Compartilhar via

Big Data Pools - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create or update a Big Data pool

Solicitação de exemplo

Resposta de exemplo

Definições

AutoPauseProperties

AutoScaleProperties

BigDataPoolResourceInfo

ConfigurationType

DynamicExecutorAllocation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LibraryInfo

LibraryRequirements

NodeSize

NodeSizeFamily

SparkConfigProperties