Big Data Pools - Create Or Update

リファレンス

サービス:: Synapse

API バージョン:: 2021-06-01

ビッグデータプールを作成します。
新しいビッグデータプールを作成します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
bigDataPoolName	path	True	string	ビッグデータプール名
resourceGroupName	path	True	string	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。
api-version	query	True	string	この操作に使用する API バージョン。
force	query		boolean	ビッグデータプールで実行中のジョブを停止するかどうかを指定します。

要求本文

名前	必須	型	説明
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	動的 Executor の割り当て
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	リソースタグ。

応答

名前	型	説明
200 OK	BigDataPoolResourceInfo	わかりました
202 Accepted	BigDataPoolResourceInfo
Other Status Codes	ErrorResponse

例

Create or update a Big Data pool

要求のサンプル

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

応答のサンプル

状態コード:: 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
  }
}

状態コード:: 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
  }
}

状態コード:: default

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

定義

名前	説明
AutoPauseProperties	Spark プールの自動一時停止プロパティ
AutoScaleProperties	Spark プールの自動スケーリングのプロパティ
BigDataPoolResourceInfo	ビッグデータプール
ConfigurationType	Spark 構成プロパティファイルの種類。
DynamicExecutorAllocation	Dynamic Executor の割り当てプロパティ
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LibraryInfo	ワークスペースレベルで作成されたライブラリ/パッケージに関する情報。
LibraryRequirements	Spark プールライブラリのバージョン要件
NodeSize	ビッグデータプール内の各ノードが持つコンピューティング能力のレベル。
NodeSizeFamily	ビッグデータプールが提供するノードの種類。
SparkConfigProperties	Spark プールの構成プロパティ

AutoPauseProperties

Spark プールの自動一時停止プロパティ

名前	型	説明
delayInMinutes	integer	ビッグデータプールが自動的に一時停止されるまでのアイドル時間 (分)。
enabled	boolean	ビッグデータプールに対して自動一時停止が有効になっているかどうか。

AutoScaleProperties

Spark プールの自動スケーリングのプロパティ

名前	型	説明
enabled	boolean	ビッグデータプールに対して自動スケーリングが有効になっているかどうか。
maxNodeCount	integer	ビッグデータプールでサポートできるノードの最大数。
minNodeCount	integer	ビッグデータプールでサポートできるノードの最小数。

BigDataPoolResourceInfo

ビッグデータプール

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /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	動的 Executor の割り当て
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 構成プロパティファイルの種類。

名前	型	説明
Artifact	string
File	string

DynamicExecutorAllocation

Dynamic Executor の割り当てプロパティ

名前	型	説明
enabled	boolean	動的実行プログラムの割り当てが有効かどうかを示します。
maxExecutors	integer	割り当てられた Executor の最大数
minExecutors	integer	割り当てられた Executor の最小数

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

LibraryInfo

ワークスペースレベルで作成されたライブラリ/パッケージに関する情報。

名前	型	説明
containerName	string	ストレージ BLOB コンテナー名。
creatorId	string	ライブラリ/パッケージの作成者 ID。
name	string	ライブラリの名前。
path	string	ライブラリのストレージ BLOB パス。
provisioningStatus	string	ライブラリ/パッケージのプロビジョニング状態。
type	string	ライブラリの種類。
uploadedTimestamp	string	ライブラリの最終更新時刻。

LibraryRequirements

Spark プールライブラリのバージョン要件

名前	型	説明
content	string	ライブラリの要件。
filename	string	ライブラリ要件ファイルのファイル名。
time	string	ライブラリ要件ファイルの最終更新時刻。

NodeSize

ビッグデータプール内の各ノードが持つコンピューティング能力のレベル。

名前	型	説明
Large	string
Medium	string
None	string
Small	string
XLarge	string
XXLarge	string
XXXLarge	string

NodeSizeFamily

ビッグデータプールが提供するノードの種類。

名前	型	説明
HardwareAcceleratedFPGA	string
HardwareAcceleratedGPU	string
MemoryOptimized	string
None	string

SparkConfigProperties

Spark プールの構成プロパティ

名前	型	説明
configurationType	ConfigurationType	Spark 構成プロパティファイルの種類。
content	string	Spark 構成プロパティ。
filename	string	Spark 構成プロパティファイルのファイル名。
time	string	Spark 構成プロパティファイルの最終更新時刻。

次の方法で共有