Custom Pools - CreateCapacityCustomPool (beta)

サービス:
Spark
API バージョン:
v1

カスタム プールを作成します。

Note

この API はベータ リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。 この API を呼び出すとき、呼び出し元はクエリ パラメーター trueの値としてbetaを指定する必要があります。

アクセス許可

呼び出し元は容量管理者である必要があります。

必要な委任スコープ

Capacity.ReadWrite.All

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

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

アイデンティティ Support
User Yes
サービス プリンシパルとマネージド ID Yes

Interface

POST https://api.fabric.microsoft.com/v1/capacities/{capacityId}/spark/pools?beta={beta}

URI パラメーター

名前 / 必須 型 説明
capacityId
 path True

string (uuid)

容量 ID。
beta
 query True

boolean

この API にアクセスするには、この必須パラメーターを true に設定する必要があります。これは現在ベータ版です。

要求本文

名前 必須 型 説明
autoScale True

AutoScaleProperties

自動スケール。
dynamicExecutorAllocation True

DynamicExecutorAllocationProperties

動的実行プログラムの割り当て。
name True

string

カスタム プール名。
名前の長さは 1 ~ 64 文字で、文字、数字、ダッシュ、アンダースコア、スペースのみを含める必要があります。
カスタム プール名は、ワークスペース内で一意である必要があります。
"スターター プール" は予約済みのカスタム プール名です。
nodeFamily True

NodeFamily

ノード ファミリ。
nodeSize True

NodeSize

ノード サイズ。

応答

名前 型 説明
201 Created

CustomPool

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

ヘッダー:

場所string- 新しく作成されたプールの URL。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

Create custom pool example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools?beta=True

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

応答のサンプル

状態コード:
201 
Location: https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7
{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Capacity",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

定義

名前 説明
AutoScaleProperties

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

カスタム プール要求ペイロードを作成します。
CustomPool

カスタム プール。
CustomPoolType

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

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

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
NodeFamily

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

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

AutoScaleProperties

Object

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

名前 型 説明
enabled

boolean

自動スケールの状態。 False - 無効、true - 有効。
maxNodeCount

integer (int32)

minimum: 1

ノードの最大数。
minNodeCount

integer (int32)

minimum: 1

最小ノード数。

CreateCustomPoolRequest

Object

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

名前 型 説明
autoScale

AutoScaleProperties

自動スケール。
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

動的実行プログラムの割り当て。
name

string

カスタム プール名。
名前の長さは 1 ~ 64 文字で、文字、数字、ダッシュ、アンダースコア、スペースのみを含める必要があります。
カスタム プール名は、ワークスペース内で一意である必要があります。
"スターター プール" は予約済みのカスタム プール名です。
nodeFamily

NodeFamily

ノード ファミリ。
nodeSize

NodeSize

ノード サイズ。

CustomPool

Object

カスタム プール。

名前 型 説明
autoScale

AutoScaleProperties

自動スケール。
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

動的実行プログラムの割り当て。
id

string (uuid)

カスタム プール ID。
name

string

カスタム プール名。
nodeFamily

NodeFamily

ノード ファミリ。
nodeSize

NodeSize

ノード サイズ。
type

CustomPoolType

カスタム プールの種類。

CustomPoolType

列挙

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

値 説明
Workspace

ワークスペース レベルのカスタム プール
Capacity

容量レベルのカスタム プール

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

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable

boolean

true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message

string

エラーの人間が理解可能な表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が理解可能な表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

NodeFamily

列挙

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

値 説明
MemoryOptimized

メモリの最適化

NodeSize

列挙

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

値 説明
Small

小さいノード サイズ
Medium

中ノード サイズ
Large

ノード サイズが大きい
XLarge

XLarge ノード サイズ
XXLarge

XXLarge ノード サイズ