Workspaces - List Workspaces

サービス:: Admin

API バージョン:: v1

ワークスペースの一覧を返します。

Note

この API はプレビューリリースの一部であり、評価と開発のみを目的として提供されます。フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。

この API では、改ページがサポートされています。要求ごとに最大 10,000 個のレコードを返すことができます。応答で提供される連続トークンを使用すると、次の 10,000 個のレコードを取得できます。

Permissions

呼び出し元は、ファブリック管理者であるか、サービスプリンシパルを使用して認証されている必要があります。

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

Tenant.Read.All または Tenant.ReadWrite.All

Limitations

1 時間あたり最大 200 要求。

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

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

Identity	Support
User	Yes
サービスプリンシパルとマネージド ID	Yes

Interface

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

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

URI パラメーター

名前	/	型	説明
capacityId	query	string (uuid)	ワークスペースの容量 ID。
continuationToken	query	string	継続トークン。リスト内の次の項目を取得するために使用されます。
name	query	string	ワークスペース名。
state	query	string	ワークスペースの状態。サポートされている状態はアクティブであり、削除されます。
type	query	string	ワークスペースの種類。サポートされている種類は、個人用、ワークスペース、管理者ワークスペースです。

応答

名前型説明

200 OK

名前	型	説明
200 OK	Workspaces	操作に成功しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: BadRequest - `workspaceType` や `workspaceState` などのクエリパラメーターが無効です。 InsufficientPrivileges - 呼び出し元に API を呼び出すアクセス許可がありません。

Workspaces

操作に成功しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

BadRequest - workspaceType や workspaceState などのクエリパラメーターが無効です。
InsufficientPrivileges - 呼び出し元に API を呼び出すアクセス許可がありません。

例

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

応答のサンプル

状態コード:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
Workspace	Workspace.
Workspaces	ワークスペースの一覧。
WorkspaceState	ワークスペースの状態。ワークスペースの状態は、時間の経過と同時に追加される場合があります。
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

Workspace.

名前	型	説明
capacityId	string (uuid)	ワークスペースの容量 ID。
domainId	string (uuid)	ワークスペースのドメイン ID。
id	string (uuid)	ワークスペース ID。
name	string	ワークスペース名。
state	WorkspaceState	ワークスペースの状態。
type	WorkspaceType	ワークスペースの種類。

Workspaces

Object

ワークスペースの一覧。

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

WorkspaceState

列挙

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

値	説明
Active	ワークスペースがアクティブです。孤立したワークスペースはアクティブとして表示されます。
Deleted	ワークスペースが削除されます。

WorkspaceType

列挙

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

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

次の方法で共有

Workspaces - List Workspaces

Permissions

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

Limitations

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

Interface

URI パラメーター

応答

例

Get a list of workspaces example

要求のサンプル

応答のサンプル

Get a list of workspaces using state query parameter example

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceState

WorkspaceType