你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Big Data Pools - Update

更新大数据池。
修补大数据池。

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

URI 参数

Name In Required Type Description
bigDataPoolName
path True
  • string

大数据池名称

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

workspaceName
path True
  • string

工作区的名称。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Type Description
tags
  • object

更新了大数据池的标记

响应

Name Type Description
200 OK
Other Status Codes

示例

Update a Big Data pool

Sample Request

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

{
  "tags": {
    "key": "value"
  }
}

Sample Response

{
  "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": "Succeeded",
    "sparkVersion": "2.4",
    "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
  }
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

定义

AutoPauseProperties

Spark 池自动暂停属性

AutoScaleProperties

Spark 池自动缩放属性

BigDataPoolPatchInfo

大数据池的修补程序

BigDataPoolResourceInfo

大数据池

ConfigurationType

spark 配置文件的类型。

DynamicExecutorAllocation

动态执行程序分配属性

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

LibraryInfo

有关在工作区级别创建的库/包的信息。

LibraryRequirements

Spark 池库版本要求

NodeSize

大数据池中每个节点的计算能力级别。

NodeSizeFamily

大数据池提供的节点类型。

SparkConfigProperties

Spark 池配置属性

AutoPauseProperties

Spark 池自动暂停属性

Name Type Description
delayInMinutes
  • integer

大数据池自动暂停前空闲时间的分钟数。

enabled
  • boolean

是否为大数据池启用自动暂停。

AutoScaleProperties

Spark 池自动缩放属性

Name Type Description
enabled
  • boolean

是否为大数据池启用自动缩放。

maxNodeCount
  • integer

大数据池可以支持的最大节点数。

minNodeCount
  • integer

大数据池可以支持的最小节点数。

BigDataPoolPatchInfo

大数据池的修补程序

Name Type Description
tags
  • object

更新了大数据池的标记

BigDataPoolResourceInfo

大数据池

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.autoPause

Spark 池自动暂停属性
自动暂停属性

properties.autoScale

Spark 池自动缩放属性
自动缩放属性

properties.cacheSize
  • integer

缓存大小

properties.creationDate
  • string

创建大数据池的时间。

properties.customLibraries

与 Spark 池关联的自定义库/包列表。

properties.defaultSparkLogFolder
  • string

将写入 Spark 日志的默认文件夹。

properties.dynamicExecutorAllocation

动态执行程序分配

properties.isAutotuneEnabled
  • boolean

启用 Autotune
是否需要自动优化。

properties.isComputeIsolationEnabled
  • boolean

是否需要计算隔离。

properties.lastSucceededTimestamp
  • string

大数据池成功更新的时间。

properties.libraryRequirements

Spark 池库版本要求
库版本要求

properties.nodeCount
  • integer

大数据池中的节点数。

properties.nodeSize

大数据池中每个节点的计算能力级别。

properties.nodeSizeFamily

大数据池提供的节点类型。

properties.provisioningState
  • string

大数据池的状态。

properties.sessionLevelPackagesEnabled
  • boolean

是否启用了会话级别包。

properties.sparkConfigProperties

Spark 池配置属性
用于指定其他属性的 Spark 配置文件

properties.sparkEventsFolder
  • string

Spark 事件文件夹

properties.sparkVersion
  • string

Apache Spark 版本。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ConfigurationType

spark 配置文件的类型。

Name Type Description
Artifact
  • string
File
  • string

DynamicExecutorAllocation

动态执行程序分配属性

Name Type Description
enabled
  • boolean

指示是否启用动态执行程序分配。

maxExecutors
  • integer

分配的执行程序的最大数目

minExecutors
  • integer

分配的执行程序最小数目

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

LibraryInfo

有关在工作区级别创建的库/包的信息。

Name Type Description
containerName
  • string

存储 Blob 容器名称。

creatorId
  • string

库/包的创建者 ID。

name
  • string

库的名称。

path
  • string

库的存储 Blob 路径。

provisioningStatus
  • string

库/包的预配状态。

type
  • string

库的类型。

uploadedTimestamp
  • string

库的上次更新时间。

LibraryRequirements

Spark 池库版本要求

Name Type Description
content
  • string

库要求。

filename
  • string

库要求文件的文件名。

time
  • string

库要求文件的上次更新时间。

NodeSize

大数据池中每个节点的计算能力级别。

Name Type Description
Large
  • string
Medium
  • string
None
  • string
Small
  • string
XLarge
  • string
XXLarge
  • string
XXXLarge
  • string

NodeSizeFamily

大数据池提供的节点类型。

Name Type Description
HardwareAcceleratedFPGA
  • string
HardwareAcceleratedGPU
  • string
MemoryOptimized
  • string
None
  • string

SparkConfigProperties

Spark 池配置属性

Name Type Description
configurationType

spark 配置文件的类型。

content
  • string

spark 配置属性。

filename
  • string

spark 配置文件的文件名。

time
  • string

spark 配置文件的上次更新时间。