Custom Pools - Update Workspace Custom Pool

リファレンス

サービス:: Spark

API バージョン:: v1

カスタムプールを更新します。

権限

呼び出し元には、管理者 ワークスペースロール 必要があります。

必要な委任されたスコープ

Workspace.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	支援
ユーザー	イエス
サービスプリンシパルのとマネージド ID の	イエス

インターフェイス

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools/{poolId}

URI パラメーター

名前	/	必須	型	説明
poolId	path	True	string (uuid)	カスタムプール ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	型	説明
autoScale	AutoScaleProperties	自動スケール。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動的実行プログラムの割り当て。
name	string	カスタムプール名。名前の長さは 1 ~ 64 文字で、文字、数字、ダッシュ、アンダースコア、スペースのみを含める必要があります。カスタムプール名は、ワークスペース内で一意である必要があります。 "スタータープール" は予約済みのカスタムプール名です。
nodeFamily	NodeFamily	ノードファミリ。
nodeSize	NodeSize	ノードサイズ。

応答

名前	型	説明
200 OK	CustomPool	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました。

名前

型

説明

200 OK

CustomPool

要求は正常に完了しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

UnknownError - エラーが発生しました。

例

Update custom pool example

要求のサンプル

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Workspace",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

定義

名前	説明
AutoScaleProperties	自動スケールのプロパティ。
CustomPool	カスタムプール。
CustomPoolType	カスタムプールの種類。追加の `CustomPoolType` 型は、時間の経過と同時に追加される場合があります。
DynamicExecutorAllocationProperties	動的な Executor の割り当ての確率。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
NodeFamily	ノードファミリ。追加の `NodeFamily` 型は、時間の経過と同時に追加される場合があります。
NodeSize	ノードサイズします。追加の `NodeSize` 型は、時間の経過と同時に追加される場合があります。
UpdateCustomPoolRequest	カスタムプール要求ペイロードを更新します。

AutoScaleProperties

Object

自動スケールのプロパティ。

名前	型	説明
enabled	boolean	自動スケールの状態。 False - 無効、true - 有効。
maxNodeCount	integer (int32) minimum: 1	ノードの最大数。
minNodeCount	integer (int32) minimum: 1	最小ノード数。

CustomPool

Object

カスタムプール。

名前	型	説明
autoScale	AutoScaleProperties	自動スケール。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動的実行プログラムの割り当て。
id	string (uuid)	カスタムプール ID。
name	string	カスタムプール名。
nodeFamily	NodeFamily	ノードファミリ。
nodeSize	NodeSize	ノードサイズ。
type	CustomPoolType	カスタムプールの種類。

CustomPoolType

列挙

カスタムプールの種類。追加の CustomPoolType 型は、時間の経過と同時に追加される場合があります。

値	説明
Capacity	容量レベルのカスタムプール
Workspace	ワークスペースレベルのカスタムプール

DynamicExecutorAllocationProperties

Object

動的な Executor の割り当ての確率。

名前	型	説明
enabled	boolean	動的実行プログラムの割り当ての状態。 False - 無効、true - 有効。
maxExecutors	integer (int32) minimum: 1	最大実行プログラム。
minExecutors	integer (int32) minimum: 1	最小実行プログラム。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

NodeFamily

列挙

ノードファミリ。追加の NodeFamily 型は、時間の経過と同時に追加される場合があります。

値	説明
MemoryOptimized	メモリ最適化

NodeSize

列挙

ノードサイズします。追加の NodeSize 型は、時間の経過と同時に追加される場合があります。

値	説明
Large	ノードサイズが大きい
Medium	中ノードサイズ
Small	小さいノードサイズ
XLarge	XLarge ノードサイズ
XXLarge	XXLarge ノードサイズ

UpdateCustomPoolRequest

Object

カスタムプール要求ペイロードを更新します。

名前	型	説明
autoScale	AutoScaleProperties	自動スケール。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動的実行プログラムの割り当て。
name	string	カスタムプール名。名前の長さは 1 ~ 64 文字で、文字、数字、ダッシュ、アンダースコア、スペースのみを含める必要があります。カスタムプール名は、ワークスペース内で一意である必要があります。 "スタータープール" は予約済みのカスタムプール名です。
nodeFamily	NodeFamily	ノードファミリ。
nodeSize	NodeSize	ノードサイズ。

次の方法で共有

Custom Pools - Update Workspace Custom Pool

権限

必要な委任されたスコープ

Microsoft Entra でサポートされている ID

インターフェイス

URI パラメーター

要求本文

応答

例

Update custom pool example

要求のサンプル

応答のサンプル

定義

AutoScaleProperties

CustomPool

CustomPoolType

DynamicExecutorAllocationProperties

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NodeFamily

NodeSize

UpdateCustomPoolRequest

その他のリソース