Items - List Environments

サービス:: Environment

API バージョン:: v1

指定したワークスペースから環境の一覧を返します。
この API では、改ページがサポートされています。

権限

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

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

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

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

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

同一性	支える
利用者	はい
サービスプリンシパルのとマネージド ID の	はい

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。
continuationToken	query		string	結果の次のページを取得するためのトークン。

応答

名前	型	説明
200 OK	Environments	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: InvalidItemType - 無効な項目の種類

名前

型

説明

200 OK

Environments

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

Other Status Codes

ErrorResponse

一般的なエラーコード:

InvalidItemType - 無効な項目の種類

例

List environments in workspace example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

定義

名前	説明
ComponentPublishInfo	環境内の各コンポーネントの情報を発行します。
Environment	環境項目。
EnvironmentProperties	環境のプロパティ。
EnvironmentPublishState	発行状態。追加の状態の種類は、時間の経過と同時に追加される場合があります。
Environments	環境の一覧。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemTag	アイテムに適用されるタグを表します。
ItemType	アイテムの種類。追加の項目の種類は、時間の経過と同時に追加される場合があります。
PublishDetails	発行操作の詳細。
SparkLibraries	Spark ライブラリ。
SparkSettings	Spark の設定。

ComponentPublishInfo

Object

環境内の各コンポーネントの情報を発行します。

名前	型	説明
sparkLibraries	SparkLibraries	Spark ライブラリは情報を発行します。
sparkSettings	SparkSettings	Spark 設定によって情報が発行されます。

Environment

Object

環境項目。

名前	型	説明
description	string	アイテムの説明。
displayName	string	アイテムの表示名。
folderId	string (uuid)	フォルダー ID。
id	string (uuid)	アイテム ID。
properties	EnvironmentProperties	環境のプロパティ。
tags	ItemTag[]	適用されたタグの一覧。
type	ItemType	アイテムの種類。
workspaceId	string (uuid)	ワークスペース ID。

EnvironmentProperties

Object

環境のプロパティ。

名前	型	説明
publishDetails	PublishDetails	環境の発行操作の詳細。

EnvironmentPublishState

列挙

発行状態。追加の状態の種類は、時間の経過と同時に追加される場合があります。

値	説明
Success	環境の発行が成功状態です。
Cancelled	環境の発行が取り消された状態です。
Failed	環境の発行が失敗した状態です。
Cancelling	環境の発行が取り消し状態です。
Running	環境の発行が実行中の状態です。
Waiting	環境の発行が待機状態です。

Environments

Object

環境の一覧。

名前	型	説明
continuationToken	string	次の結果セットバッチのトークン。これ以上レコードがない場合は、応答から削除されます。
continuationUri	string	次の結果セットバッチの URI。これ以上レコードがない場合は、応答から削除されます。
value	Environment[]	環境の一覧。

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	エラー関連のリソースの詳細。

ItemTag

Object

アイテムに適用されるタグを表します。

名前	型	説明
displayName	string	タグの名前。
id	string (uuid)	タグ ID。

ItemType

列挙

アイテムの種類。追加の項目の種類は、時間の経過と同時に追加される場合があります。

値	説明
Dashboard	PowerBI ダッシュボード。
Report	PowerBI レポート。
SemanticModel	PowerBI セマンティックモデル。
PaginatedReport	PowerBI のページ分割されたレポート。
Datamart	PowerBI データマート。
Lakehouse	レイクハウス。
Eventhouse	イベントハウス。
Environment	環境。
KQLDatabase	KQL データベース。
KQLQueryset	KQL クエリセット。
KQLDashboard	KQL ダッシュボード。
DataPipeline	データパイプライン。
Notebook	ノートブック。
SparkJobDefinition	Spark ジョブ定義。
MLExperiment	機械学習の実験。
MLModel	機械学習モデル。
Warehouse	倉庫。
Eventstream	イベントストリーム。
SQLEndpoint	SQL エンドポイント。
MirroredWarehouse	ミラー化された倉庫。
MirroredDatabase	ミラー化されたデータベース。
Reflex	反射。
GraphQLApi	GraphQL 項目の API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	コピージョブ。
VariableLibrary	VariableLibrary。
Dataflow	データフロー。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	Warehouse スナップショット。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	デジタルツインビルダーフロー。
MirroredAzureDatabricksCatalog	ミラー化された Azure databricks カタログ。
Map	マップ。
AnomalyDetector	Anomaly Detector。
UserDataFunction	ユーザーデータ関数。
GraphModel	GraphModel。
GraphQuerySet	Graph QuerySet。
SnowflakeDatabase	Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB データベース。
Ontology	オントロジ。
EventSchemaSet	EventSchemaSet。

PublishDetails

Object

発行操作の詳細。

名前	型	説明
componentPublishInfo	ComponentPublishInfo	環境コンポーネントが情報を発行します。
endTime	string (date-time)	YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の終了時刻 (UTC)。
startTime	string (date-time)	YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の開始時刻 (UTC)。
state	EnvironmentPublishState	発行状態。追加の状態の種類は、時間の経過と同時に追加される場合があります。
targetVersion	string (uuid)	公開対象のバージョン。

SparkLibraries

Object

Spark ライブラリ。

名前	型	説明
state	EnvironmentPublishState	発行状態。追加の状態の種類は、時間の経過と同時に追加される場合があります。

SparkSettings

Object

Spark の設定。

名前	型	説明
state	EnvironmentPublishState	発行状態。追加の状態の種類は、時間の経過と同時に追加される場合があります。

次の方法で共有

Items - List Environments

権限

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

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

インターフェイス

URI パラメーター

応答

例

List environments in workspace example

要求のサンプル

応答のサンプル

定義

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings