Big Data Pools - Create Or Update

建立巨量數據集區。
建立新的巨量數據集區。

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

URI 參數

名稱 位於 必要 類型 Description
bigDataPoolName
path True

string

巨量數據集區名稱

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

workspaceName
path True

string

工作區的名稱。

api-version
query True

string

用於此作業的 API 版本。

force
query

boolean

是否要停止巨量數據集區中的任何執行中作業

要求本文

名稱 必要 類型 Description
location True

string

資源所在的地理位置

properties.autoPause

AutoPauseProperties

Spark 集區自動暫停屬性
自動暫停屬性

properties.autoScale

AutoScaleProperties

Spark 集區自動調整屬性
自動調整屬性

properties.cacheSize

integer

快取大小

properties.customLibraries

LibraryInfo[]

與 Spark 集區相關聯的自訂連結庫/套件清單。

properties.defaultSparkLogFolder

string

將寫入 Spark 記錄的預設資料夾。

properties.dynamicExecutorAllocation

DynamicExecutorAllocation

動態執行程式配置

properties.isAutotuneEnabled

boolean

啟用自動調整
是否需要自動調整。

properties.isComputeIsolationEnabled

boolean

是否需要計算隔離。

properties.libraryRequirements

LibraryRequirements

Spark 集區連結庫版本需求
連結庫版本需求

properties.nodeCount

integer

巨量數據集區中的節點數目。

properties.nodeSize

NodeSize

巨量數據集區中每個節點的計算能力層級。

properties.nodeSizeFamily

NodeSizeFamily

巨量數據集區提供的節點種類。

properties.provisioningState

string

巨量數據集區的狀態。

properties.sessionLevelPackagesEnabled

boolean

會話層級套件是否已啟用。

properties.sparkConfigProperties

SparkConfigProperties

Spark 集區組態屬性
用來指定其他屬性的 Spark 組態檔

properties.sparkEventsFolder

string

Spark 事件資料夾

properties.sparkVersion

string

Apache Spark 版本。

tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

BigDataPoolResourceInfo

確定

202 Accepted

BigDataPoolResourceInfo

Other Status Codes

ErrorResponse

範例

Create or update a Big Data pool

Sample Request

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

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

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

定義

名稱 Description
AutoPauseProperties

Spark 集區自動暫停屬性

AutoScaleProperties

Spark 集區自動調整屬性

BigDataPoolResourceInfo

巨量數據集區

ConfigurationType

Spark 組態屬性檔的類型。

DynamicExecutorAllocation

動態執行程式配置屬性

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

LibraryInfo

在工作區層級建立的連結庫/套件相關信息。

LibraryRequirements

Spark 集區連結庫版本需求

NodeSize

巨量數據集區中每個節點的計算能力層級。

NodeSizeFamily

巨量數據集區提供的節點種類。

SparkConfigProperties

Spark 集區組態屬性

AutoPauseProperties

Spark 集區自動暫停屬性

名稱 類型 Description
delayInMinutes

integer

巨量數據集區自動暫停之前的空閒時間分鐘數。

enabled

boolean

是否已啟用巨量數據集區的自動暫停。

AutoScaleProperties

Spark 集區自動調整屬性

名稱 類型 Description
enabled

boolean

是否為巨量數據集區啟用自動調整。

maxNodeCount

integer

巨量數據集區可支持的節點數目上限。

minNodeCount

integer

巨量數據集區可支持的節點數目下限。

BigDataPoolResourceInfo

巨量數據集區

名稱 類型 Description
id

string

資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

資源所在的地理位置

name

string

資源的名稱

properties.autoPause

AutoPauseProperties

Spark 集區自動暫停屬性
自動暫停屬性

properties.autoScale

AutoScaleProperties

Spark 集區自動調整屬性
自動調整屬性

properties.cacheSize

integer

快取大小

properties.creationDate

string

建立巨量數據集區的時間。

properties.customLibraries

LibraryInfo[]

與 Spark 集區相關聯的自訂連結庫/套件清單。

properties.defaultSparkLogFolder

string

將寫入 Spark 記錄的預設資料夾。

properties.dynamicExecutorAllocation

DynamicExecutorAllocation

動態執行程式配置

properties.isAutotuneEnabled

boolean

啟用自動調整
是否需要自動調整。

properties.isComputeIsolationEnabled

boolean

是否需要計算隔離。

properties.lastSucceededTimestamp

string

成功更新巨量數據集區的時間。

properties.libraryRequirements

LibraryRequirements

Spark 集區連結庫版本需求
連結庫版本需求

properties.nodeCount

integer

巨量數據集區中的節點數目。

properties.nodeSize

NodeSize

巨量數據集區中每個節點的計算能力層級。

properties.nodeSizeFamily

NodeSizeFamily

巨量數據集區提供的節點種類。

properties.provisioningState

string

巨量數據集區的狀態。

properties.sessionLevelPackagesEnabled

boolean

會話層級套件是否已啟用。

properties.sparkConfigProperties

SparkConfigProperties

Spark 集區組態屬性
用來指定其他屬性的 Spark 組態檔

properties.sparkEventsFolder

string

Spark 事件資料夾

properties.sparkVersion

string

Apache Spark 版本。

tags

object

資源標籤。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ConfigurationType

Spark 組態屬性檔的類型。

名稱 類型 Description
Artifact

string

File

string

DynamicExecutorAllocation

動態執行程式配置屬性

名稱 類型 Description
enabled

boolean

指出是否啟用動態執行程式配置。

maxExecutors

integer

已標註的執行程序數目上限

minExecutors

integer

已標註的執行程序數目下限

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

LibraryInfo

在工作區層級建立的連結庫/套件相關信息。

名稱 類型 Description
containerName

string

記憶體 Blob 容器名稱。

creatorId

string

連結庫/套件的建立者標識符。

name

string

連結庫的名稱。

path

string

連結庫的記憶體 Blob 路徑。

provisioningStatus

string

連結庫/套件的布建狀態。

type

string

連結庫的類型。

uploadedTimestamp

string

連結庫的上次更新時間。

LibraryRequirements

Spark 集區連結庫版本需求

名稱 類型 Description
content

string

連結庫需求。

filename

string

連結庫需求檔案的檔名。

time

string

連結庫需求檔案的上次更新時間。

NodeSize

巨量數據集區中每個節點的計算能力層級。

名稱 類型 Description
Large

string

Medium

string

None

string

Small

string

XLarge

string

XXLarge

string

XXXLarge

string

NodeSizeFamily

巨量數據集區提供的節點種類。

名稱 類型 Description
HardwareAcceleratedFPGA

string

HardwareAcceleratedGPU

string

MemoryOptimized

string

None

string

SparkConfigProperties

Spark 集區組態屬性

名稱 類型 Description
configurationType

ConfigurationType

Spark 組態屬性檔的類型。

content

string

Spark 組態屬性。

filename

string

spark 組態屬性檔案的檔名。

time

string

Spark 組態屬性檔的最後一次更新時間。