Published - Get Spark Compute

Service:: Environment

API バージョン:: v1

環境の Spark コンピューティングを取得します。

注

この API は、2027 年 3 月 31 日に非推奨となるベータ版のリリースバージョンです。 この API を呼び出すとき - 呼び出し元は、クエリパラメーター beta 値を設定する必要があります false

Permissions

環境項目の読み取りアクセス許可。

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

Item.Read.All または Item.ReadWrite.All または Environment.Read.All または Environment.ReadWrite.All

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta={beta}

URI パラメーター

Name	/	必須	型	説明
environmentId	path	True	string (uuid)	環境 ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
beta	query	True	boolean	このパラメーターは、使用する API のバージョンを指定します。リリースバージョンを使用するには、 `false` に設定します。

応答

Name 型説明

200 OK

Name	型	説明
200 OK	EnvironmentSparkCompute	要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました。

EnvironmentSparkCompute

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

429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

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

例

Get environment Spark compute example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?beta=false

応答のサンプル

状態コード:: 200

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603",
    "maxClustersToHydrateLimit": 10
  },
  "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",
  "customLivePoolSupport": "Enabled",
  "customLivePoolSettings": {
    "maxClustersToHydrate": 4,
    "clusterIdleTimeout": "PT20M",
    "customLivePoolLifespan": "PT1H"
  }
}

定義

Name	説明
CustomLivePoolSettings	環境の Spark コンピューティングでのライブプールハイドレーション設定。
CustomLivePoolSupport	ライブプールのサポートがアクティブかどうかを制御するフラグ。 `CustomLivePoolSupport`の値は、時間の経過と同時に追加される場合があります。
CustomPoolMemory	Spark ドライバーまたは Spark Executor のカスタムプールメモリ。追加の `CustomPoolMemory` 型は、時間の経過と同時に追加される場合があります。
CustomPoolType	カスタムプールの種類。追加の `CustomPoolType` 型は、時間の経過と同時に追加される場合があります。
DynamicExecutorAllocationProperties	動的な Executor の割り当ての確率。
EnvironmentSparkCompute
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
InstancePool	インスタンスプール。
SparkProperty	Spark プロパティキーとその値。

CustomLivePoolSettings

Object

環境の Spark コンピューティングでのライブプールハイドレーション設定。

Name	型	説明
clusterIdleTimeout	string (duration)	ISO 8601 期間形式を使用して、ハイドレートされたクラスターが解放されるアイドル時間のしきい値。最小: PT20M。最大: PT24H。
customLivePoolLifespan	string (duration)	ISO 8601 期間形式を使用した、ライブプールのアクティブ化の最大有効期間。ライブプールジョブはこの期間実行され、終了します。最小: PT30M。最大: PT24H。
maxClustersToHydrate	integer (int32) minimum: 1	各アクティブ化サイクル中に事前ハイドレートするクラスターの最大数。最小値: 1。許容される最大値は容量サイズによって決定され、インスタンスプールの設定で `InstancePool.maxClustersToHydrateLimit`として公開されます。

CustomLivePoolSupport

列挙

ライブプールのサポートがアクティブかどうかを制御するフラグ。 CustomLivePoolSupportの値は、時間の経過と同時に追加される場合があります。

値	説明
Enabled	ライブプールのサポートはアクティブです。
Disabled	ライブプールのサポートは非アクティブです。構成は保持されます。

CustomPoolMemory

列挙

Spark ドライバーまたは Spark Executor のカスタムプールメモリ。追加の CustomPoolMemory 型は、時間の経過と同時に追加される場合があります。

値	説明
28g	28 GB メモリ。
56g	56G メモリ。
112g	112G メモリ。
224g	224G メモリ。
400g	400G メモリ。

CustomPoolType

列挙

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

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

DynamicExecutorAllocationProperties

Object

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

Name	型	説明
enabled	boolean	動的実行プログラムの割り当ての状態。 False - 無効、true - 有効。
maxExecutors	integer (int32) minimum: 1	動的割り当ての Executor の最大数と、このプロパティの最小値は 1 です。最大値は、インスタンスプールの `maxNodeCount`よりも小さくする必要があります。
minExecutors	integer (int32) minimum: 1	動的割り当ての実行プログラムの最小数と、このプロパティの最小値は 1 です。最大値は `maxExecutors`より小さくする必要があります。

EnvironmentSparkCompute

Object

Name	型	説明
customLivePoolSettings	CustomLivePoolSettings	ライブプールハイドレーションの設定。ライブプールのサポートが有効な場合にクラスターを事前ハイドレートする方法を制御します。
customLivePoolSupport	CustomLivePoolSupport	ライブプールが有効かどうかを制御します。 `Enabled`すると、クラスターはハイドレート設定に従って事前ハイドレートされるため、コールドスタート待機時間なしでワークロードが開始されます。
driverCores	integer (int32)	Spark ドライバーコア。 4、8、16、32、64 のいずれかの値を指定する必要があります。
driverMemory	CustomPoolMemory	Spark ドライバーメモリ。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動的実行プログラムの割り当て。
executorCores	integer (int32)	Spark Executor コア。 4、8、16、32、64 のいずれかの値を指定する必要があります。
executorMemory	CustomPoolMemory	Spark Executor メモリ。
instancePool	InstancePool	環境プールは、有効なカスタムプールである必要があります。 "スタータープール" とは、スタータープールを使用することです。
runtimeVersion	string	ランタイムバージョン。サポートされているファブリックランタイムを見つけます。例: 1.3
sparkProperties	SparkProperty[]	Spark プロパティ。

ErrorParameter

Object

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name	型	説明
message	string	パラメーターの意味を人間が判読できる説明。
name	string	パラメータ識別子です。
value	string	パラメーターの値を指定します。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

エラー応答。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 `Retry-After`応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

InstancePool

Object

インスタンスプール。

Name	型	説明
id	string (uuid)	インスタンスプール ID。
maxClustersToHydrateLimit	integer (int32)	このプールに関連付けられている容量サイズによって決定される、ライブプールの `maxClustersToHydrate` 設定のサーバー計算された上限。
name	string	インスタンスプール名。
type	CustomPoolType	インスタンスプールの種類。

SparkProperty

Object

Spark プロパティキーとその値。

Name	型	説明
key	string	Spark プロパティキー。
value	string	Spark プロパティの値。