パブリック API を使用して環境を管理します

Microsoft Fabric REST API は、Fabric 項目の作成、読み取り、更新、削除 (CRUD) 操作用のサービスエンドポイントを提供します。この記事では、使用可能な環境 REST API とそれらの使用方法について説明します。

環境 API を安定した GA バージョンに移行する

重要

GA リリースには、既存の API、API の非推奨、および新しい API の要求/応答コントラクトの更新が含まれています。詳細については、次のセクションを参照してください。
要求/応答コントラクトの変更の移行を容易にするために、新しいクエリパラメーター beta が導入されました。 beta クエリパラメーターの既定値は Trueまでされるため、プレビューコントラクトは引き続き使用できます。コントラクトの安定したリリースバージョンの使用を開始するには、値を False に設定します。
Preview クエリパラメーターが betaに置き換えられました。下位互換性のために、プレビューは引き続きサポートされており、ベータ版と同じように動作します。
非推奨予定のAPIは、2026年3月31日までサポートされ続けます。できるだけ早く新たに導入されたAPIを使用して置き換えてください。

要求/応答コントラクトの更新を含む API

カテゴリ	API	説明	注記	Swagger のプレビューバージョン	リリースバージョンのSwagger
アイテム操作	環境を公開する	現在の未決定の変更を適用し、環境の公開操作を開始します。	応答契約を更新します。	公開環境 (プレビュー版)	発行環境
ステージング	ステージングライブラリを一覧表示する	ステージングライブラリの完全な一覧を取得します。この一覧には、公開済みライブラリと保留中のライブラリが含まれます。	応答契約を更新します。	ステージングライブラリの一覧表示 (プレビュー)	ステージングライブラリを一覧表示する
ステージング	準備段階の Spark 計算を一覧表示する	完全なステージングコンピューティング構成を取得します。ステージング構成には、公開済みのコンピューティング構成と保留中のコンピューティング構成が含まれます。	応答契約を更新します。	ステージング環境のSparkコンピューティング一覧 (プレビュー)	Spark コンピュート環境のステージングを一覧表示する
ステージング	Spark コンピューティングを更新する	環境のコンピューティング構成と Spark プロパティを更新します。	要求と応答のコントラクトの更新。	Spark コンピューティングの更新 (プレビュー)	Spark コンピューティングを更新する
公開済み	発行済みライブラリを一覧表示する	Spark セッションで発行され、有効なライブラリを取得します。	応答契約を更新します。	発行済みライブラリの一覧表示 (プレビュー)	発行済みライブラリを一覧表示する
公開済み	公開された Spark コンピュートをリストする	Spark セッションで発行され、有効な Spark コンピューティング構成と Spark プロパティを取得します。	応答契約を更新します。	発行済みライブラリの一覧表示 (プレビュー)	発行済みライブラリを一覧表示する

beta パラメーターの既定値はTrue 日までされます。つまり、非推奨の日付までこのパラメーターを指定せずに要求が送信される場合、システムはパラメーターをTrueと見なします。 beta パラメーターをできるだけ早くFalseに明示的に設定して、実装を安定バージョンに移行することを強くお勧めします。

例として List staging libraries API を使用します。API 応答に更新があります。

beta パラメーターを指定して要求を送信する場合はTrue

要求のサンプル:

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

応答の例:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

preview パラメーターを指定して要求を送信する場合はFalse

要求のサンプル:

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

応答の例:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

非推奨となる API

重要

非推奨予定のAPIは2026年3月31日まで引き続きサポートされます。新しく導入された API を使用して、できるだけ早く実装を置き換えることを強くお勧めします。

カテゴリ	API	説明	注
ステージング	ステージングライブラリをアップロードする	環境内に 1 つのカスタムライブラリまたは 1 つまたは複数のパブリックライブラリを追加します。	2026 年 3 月 31 日までのサポートでは、新しく導入された`Import external libraries`/`Upload custom library` API を使用して置き換えてください。
ステージング	ステージングライブラリを削除する	1 つのステージングカスタムライブラリまたはすべてのパブリックライブラリを削除します。	2026 年 3 月 31 日までのサポートでは、新しく導入された`Remove external library`/`Delete custom library` API を使用して置き換えてください。

以下に、ステージングライブラリを管理する場合のシナリオを説明する例をいくつか示します。

環境内にパブリックライブラリを追加する

以前は、 Upload staging libraries API を使用して更新された YAML ファイルをアップロードできるようになりました。これで、 Import external libraries API を使用して更新された YAML をインポートできるようになりました。
環境内の 1 つのパブリックライブラリを削除する

以前は、 Upload staging libraries API を使用して更新された YAML ファイルをアップロードすることができ、 Remove external library API を使用して削除できるようになりました。
環境内のすべてのパブリックライブラリを削除する

以前は、 Delete staging libraries API を使用してすべてのパブリックライブラリを削除できます。これで、 Remove external library API を使用してパブリックライブラリを 1 つずつ削除したり、 Import external libraries を使用して空の YAML ファイルをアップロードして同じ機能を実現したりできるようになりました。

新しい API

カテゴリ	API	説明	注
アイテム操作	定義を使用して環境を作成する	定義を使用して新しい環境を作成します。	新しい API。
アイテム操作	環境定義を取得する	環境の定義を取得します。	新しい API。
アイテム操作	環境定義を更新する	環境の定義を更新します。	新しい API。
ステージング	外部ライブラリをインポートする	外部ライブラリを environment.yml ファイルとして環境にアップロードします。これは、環境内の既存の外部ライブラリの一覧をオーバーライドします。	新しい API。
ステージング	外部ライブラリをエクスポートする	完全な外部ライブラリを environment.yml ファイルとして取得します。	新しい API。
ステージング	外部ライブラリを削除する	環境から外部ライブラリを削除します。この API は、一度に 1 つのライブラリを受け入れます。	新しい API。
ステージング	カスタムライブラリをアップロードする	環境でカスタムパッケージをアップロードします。この API を使用すると、一度に 1 つのファイルをアップロードできます。サポートされているファイル形式は、.jar、.py、.whl、および.tar.gzです。	新しい API。
ステージング	カスタムライブラリを削除する	環境からカスタムパッケージを削除します。カスタムパッケージの完全な名前と拡張機能を API 要求に配置して削除します。	新しい API。
公開済み	外部ライブラリをエクスポートする	発行された外部ライブラリを environment.yml ファイルとして取得します。	新しい API。

更新なしの API

カテゴリ	API	説明
アイテム操作	環境の作成	ワークスペースに新しい空の環境を作成します。
アイテム操作	環境を取得する	環境のメタデータを取得します。応答には、環境の状態が含まれます。
アイテム操作	環境の削除	既存の環境を削除する
アイテム操作	環境を一覧表示する	ワークスペース内の環境の一覧を取得します。
アイテム操作	環境の更新	名前や説明など、環境のメタデータを更新します。
アイテム操作	発行環境を取り消す	環境の進行中の公開操作を取り消します。

環境パブリック API の詳細については、「項目 API - 環境」を参照してください。

環境パブリック API のユースケース

重要

このセクションでは、安定したリリースバージョンの API について説明します。

このセクションでは、API を使用して環境を管理するときに特定のシナリオを実現する方法について説明します。次の例では、 {WORKSPACE_ID} プロパティと {ARTIFACT_ID} プロパティを適切な値に置き換えることができます。

新規環境の作成

新しい空の環境を作成するには、次の API を使用します。

サンプルリクエスト

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

ステージングライブラリを管理する

アップロードと削除のステージングライブラリ API を使用して、環境内のライブラリセクションを管理できます。

環境の公開済みライブラリを確認する

ライブラリを追加または削除する前に、発行済みライブラリの取得 API を使用して、現在有効なライブラリを確認します。

サンプルリクエスト

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

サンプル応答

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

パブリックライブラリのインポートまたはカスタムライブラリのアップロード

外部ライブラリのインポートとカスタムライブラリ API のアップロードを使用して、新しいパブリック/カスタムライブラリを環境に追加できます。インポート外部ライブラリ API は environment.yml ファイルを受け入れますが、サポートされているファイルの種類は、カスタムライブラリ API のアップロード用の .whl、 .jar、 .tar.gz、 .py です。

注

パブリックライブラリをより効率的に操作するには、PyPI と Conda から必要なすべてのライブラリを environment.yml ファイルで作成することをお勧めします。

アップロード API では、1 回の要求で最大 200 MB のファイルを使用できます。現在、このサイズ制限を超えるライブラリは、パブリック API ではサポートされていません。

サンプルの要求

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

カスタムライブラリを削除する

タイプサフィックスを持つ完全なライブラリファイル名を指定することで、一度に 1 つのカスタムライブラリを削除できます。

注

既存のパブリックライブラリまたはそのすべてのサブセットを削除する場合は、 Import public libraries API を使用して更新された YAML ファイルをインポートしてください。

サンプルの要求

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Sparkコンピュートのステージングを管理する

更新ステージング Spark コンピューティングを使用して、Spark コンピューティングを管理できます。

発行された Spark コンピューティングの環境を確認する

環境の構成を変更する前に、発行済みの Spark コンピューティング API を使用して、現在有効な Spark コンピューティング構成を確認します。

サンプルリクエスト

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/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"
}

コンピューティング構成を更新する

この API の要求本文を編集することで、Spark ランタイムの更新、別のプールへの切り替え、コンピューティング構成の調整、Spark プロパティの追加または削除を行うことができます。

プール名とプールを指定することで、接続されているプールを切り替えることができます。プールを既定の設定に切り替えるには、プール名を Starter Pool として指定します。 REST API によってワークスペースの使用可能なカスタムプールの完全な一覧を取得するには、「カスタムプール - ワークスペースのカスタムプールの一覧表示」を参照してください。

既存の Spark プロパティを削除する場合は、削除するキーを null として値を指定します。

サンプルリクエスト

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

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

変更を有効にする

変更を発行するには、次の API のセットを使用します。

発行操作の準備

環境では、一度に 1 つの発行操作を受け入れることもできます。環境を発行する前に、環境の状態を検証し、ステージングの変更を最終確認します。環境が正常に発行されると、ステージング状態のすべての構成が有効になります。

手順 1: 環境のメタデータを取得します。
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
応答本文では、環境の状態を明確に伝えることができます。次の手順に進む前に、発行操作が進行中でないことを確認してください。

手順 2: ステージングライブラリ/Spark コンピューティングを取得して、最終的なレビューを行います。

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

環境の発行操作をトリガーする

ステージングライブラリと Spark コンピューティングに対して行った変更はキャッシュされますが、発行を有効にするには必要です。次の例を使用して、発行操作をトリガーします。応答は実行時間の長い操作 (LRO) パターンに従っており、HTTP 応答コード 202 が返される可能性があります。

サンプルリクエスト

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

サンプル応答

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

発行操作中に、次の API を呼び出して取り消すこともできます。

サンプルリクエスト

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-10-09

次の方法で共有

パブリック API を使用して環境を管理します

環境 API を安定した GA バージョンに移行する

要求/応答コントラクトの更新を含む API

非推奨となる API

新しい API

更新なしの API

環境パブリック API のユース ケース

新規環境の作成

ステージング ライブラリを管理する

環境の公開済みライブラリを確認する

パブリック ライブラリのインポートまたはカスタム ライブラリのアップロード

カスタム ライブラリを削除する

Sparkコンピュートのステージングを管理する

発行された Spark コンピューティングの環境を確認する

コンピューティング構成を更新する

変更を有効にする

発行操作の準備

環境の発行操作をトリガーする

関連するコンテンツ

フィードバック

その他のリソース

環境パブリック API のユースケース

ステージングライブラリを管理する

パブリックライブラリのインポートまたはカスタムライブラリのアップロード

カスタムライブラリを削除する