Published - Get Spark Compute
環境の Spark コンピューティングを取得します。
注
この API は、2026 年 3 月 1 日に非推奨となるベータ 版のリリース バージョンです。
この API を呼び出すとき - 呼び出し元は、クエリ パラメーター beta 値を設定する必要があります false
Permissions
環境項目の読み取りアクセス許可。
必要な委任されたスコープ
Item.Read.All または Item.ReadWrite.All または Environment.Read.All または Environment.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | Support |
|---|---|
| User | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta={beta}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
environment
|
path | True |
string (uuid) |
環境 ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
|
beta
|
query | True |
boolean |
このパラメーターは、使用する API のバージョンを指定します。 リリース バージョンを使用するには、 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Get environment Spark compute example
要求のサンプル
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?beta=false
応答のサンプル
{
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": [
{
"key": "spark.acls.enable",
"value": "false"
}
],
"runtimeVersion": "1.2"
}
定義
| 名前 | 説明 |
|---|---|
|
Custom |
Spark ドライバーまたは Spark Executor のカスタム プール メモリ。 追加の |
|
Custom |
カスタム プールの種類。 追加の |
|
Dynamic |
動的な Executor の割り当ての確率。 |
|
Environment |
|
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Instance |
プールのインスタンス。 |
|
Spark |
Spark プロパティ キーとその値。 |
CustomPoolMemory
Spark ドライバーまたは Spark Executor のカスタム プール メモリ。 追加の CustomPoolMemory 型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| 28g |
28 GB メモリ。 |
| 56g |
56G メモリ。 |
| 112g |
112G メモリ。 |
| 224g |
224G メモリ。 |
| 400g |
400G メモリ。 |
CustomPoolType
カスタム プールの種類。 追加の CustomPoolType 型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Workspace |
ワークスペース カスタム プール |
| Capacity |
容量カスタム プール |
DynamicExecutorAllocationProperties
動的な Executor の割り当ての確率。
| 名前 | 型 | 説明 |
|---|---|---|
| enabled |
boolean |
動的実行プログラムの割り当ての状態。 False - 無効、true - 有効。 |
| maxExecutors |
integer (int32) minimum: 1 |
動的割り当ての Executor の最大数と、このプロパティの最小値は 1 です。 最大値は、インスタンス プールの |
| minExecutors |
integer (int32) minimum: 1 |
動的割り当ての実行プログラムの最小数と、このプロパティの最小値は 1 です。 最大値は |
EnvironmentSparkCompute
| 名前 | 型 | 説明 |
|---|---|---|
| driverCores |
integer (int32) |
Spark ドライバー コア。 4、8、16、32、64 のいずれかの値を指定する必要があります。 |
| driverMemory |
Spark ドライバー メモリ。 |
|
| dynamicExecutorAllocation |
動的実行プログラムの割り当て。 |
|
| executorCores |
integer (int32) |
Spark Executor コア。 4、8、16、32、64 のいずれかの値を指定する必要があります。 |
| executorMemory |
Spark Executor メモリ。 |
|
| instancePool |
環境プールは、有効なカスタム プールである必要があります。 "スターター プール" とは、スターター プールを使用することです。 |
|
| runtimeVersion |
string |
ランタイム バージョン。サポートされている ファブリック ランタイムを見つけます。 例: 1.3 |
| sparkProperties |
Spark プロパティ。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
InstancePool
プールのインスタンス。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (uuid) |
インスタンス プール ID。 |
| name |
string |
インスタンス プール名。 |
| type |
インスタンス プールの種類。 |
SparkProperty
Spark プロパティ キーとその値。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
Spark プロパティ キー。 |
| value |
string |
Spark プロパティの値。 |