次の方法で共有

Custom Pools - List Workspace Custom Pools

  • リファレンス
サービス:
Spark
API バージョン:
v1

カスタム プールを一覧表示します。

権限

呼び出し元には、ビューアー 以上のワークスペース ロールが必要です。

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

Workspace.Read.All または Workspace.ReadWrite.All

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools
省略可能なパラメーターを含む: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools?continuationToken={continuationToken}

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。
continuationToken
 query

string

継続トークン。 リスト内の次の項目を取得するために使用されます。

応答

名前 型 説明
200 OK

CustomPools

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

ErrorResponse

一般的なエラー コード:

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

例

List custom pools example
List custom pools with continuation example

List custom pools example

要求のサンプル

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Starter Pool",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Medium",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 10
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 9
      }
    },
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ]
}

List custom pools with continuation example

要求のサンプル

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools?continuationToken=LDEsMTAwMDAwLDA%3D"
}

定義

名前 説明
AutoScaleProperties

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

カスタム プール。
CustomPools
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

最小ノード数。

CustomPool

Object

カスタム プール。

名前 型 説明
autoScale

AutoScaleProperties

自動スケール。
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

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

string (uuid)

カスタム プール ID。
name

string

カスタム プール名。
nodeFamily

NodeFamily

ノード ファミリ。
nodeSize

NodeSize

ノード サイズ。
type

CustomPoolType

カスタム プールの種類。

CustomPools

Object
名前 型 説明
continuationToken

string

次の結果セット バッチのトークン。 これ以上レコードがない場合は、応答から削除されます。
continuationUri

string

次の結果セット バッチの URI。 これ以上レコードがない場合は、応答から削除されます。
value

CustomPool[]

カスタム プールの一覧。

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 ノード サイズ