Workspaces - List Workspaces

サービス:: Core

API バージョン:: v1

プリンシパルがアクセスできるワークスペースの一覧を返します。 roles クエリパラメーターを使用して、プリンシパルワークスペースロールで結果をフィルター処理します。
この API では、改ページ位置の修正がサポートされています。

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

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

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces

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

GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI パラメーター

名前	/	型	説明
continuationToken	query	string	結果の次のページを取得するためのトークン。
preferWorkspaceSpecificEndpoints	query	boolean	ワークスペースごとにワークスペース固有の API エンドポイントを含めるかどうかを制御する設定。 True - ワークスペース固有の API エンドポイントを含めます。False - ワークスペース固有の API エンドポイントは含めないでください。
roles	query	string	ロールの一覧。コンマを使用して値を区切ります。指定しない場合は、すべてのワークスペースが返されます。

応答

名前	型	説明
200 OK	Workspaces	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: InvalidParameter - ワークスペースロールが無効です。 UnknownError - エラーが発生しました。

名前

型

説明

200 OK

Workspaces

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

Other Status Codes

ErrorResponse

一般的なエラーコード:

InvalidParameter - ワークスペースロールが無効です。
UnknownError - エラーが発生しました。

例

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29"
    }
  ]
}

List workspaces with continuation example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
Workspace	ワークスペースオブジェクト。
Workspaces
WorkspaceType	ワークスペースの種類。追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。

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

Workspace

Object

ワークスペースオブジェクト。

名前	型	説明
apiEndpoint	string (uri)	ワークスペースに固有の API エンドポイントを表す HTTP URL。このエンドポイント値は、ユーザーが preferWorkspaceSpecificEndpoints を有効にすると返されます。これにより、プライベートリンク経由で API にアクセスできます。
capacityId	string (uuid)	ワークスペースが割り当てられている容量の ID。
description	string	ワークスペースの説明。
displayName	string	ワークスペースの表示名。
domainId	string (uuid)	ワークスペースが割り当てられているドメインの ID。
id	string (uuid)	ワークスペース ID。
type	WorkspaceType	ワークスペースの種類。

Workspaces

Object

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

WorkspaceType

列挙

ワークスペースの種類。追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。

値	説明
Personal	ユーザーアイテムの管理に使用するマイフォルダーまたはマイワークスペース。
Workspace	Fabric アイテムの管理に使用されるワークスペース。
AdminWorkspace	管理者監視ワークスペース。監査レポートや使用状況と導入レポートなどの管理者レポートが含まれます。

次の方法で共有

Workspaces - List Workspaces

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

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

インターフェイス

URI パラメーター

応答

例

List workspaces example

要求のサンプル

応答のサンプル

List workspaces with continuation example

要求のサンプル

応答のサンプル

List workspaces with preferWorkspaceSpecificEndpoints example

要求のサンプル

応答のサンプル

List workspaces with roles filter example

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceType