次の方法で共有

Workspaces - Get Workspace

サービス:
Core
API バージョン:
v1

指定したワークスペース情報を返します。

権限

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

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

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

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

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

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

インターフェイス

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}
省略可能なパラメーターを含む: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}?preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。
preferWorkspaceSpecificEndpoints
 query

boolean

API および OneLake アクセス用にワークスペース固有または一般的なパブリック エンドポイントを含めるかどうかを制御する設定。 True - API および OneLake アクセスにワークスペース固有のエンドポイントを含める、False - OneLake アクセスの一般的なパブリック エンドポイントを含めます。

応答

名前 型 説明
200 OK

WorkspaceInfo

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

ErrorResponse

一般的なエラー コード:

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

例

Get a workspace example
Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

要求のサンプル

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

応答のサンプル

状態コード:
200 
{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

定義

名前 説明
CapacityAssignmentProgress

容量の進行状況の状態に対するワークスペースの割り当て。 追加の容量割り当ての進行状況の値は、時間の経過と同時に追加される場合があります。
CapacityRegion

このワークスペースに関連付けられている容量のリージョン。 容量リージョンの値は、時間の経過と同時に追加される場合があります。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
OneLakeEndpoints

このワークスペースに関連付けられている OneLake API エンドポイント。
WorkspaceIdentity

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

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

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

CapacityAssignmentProgress

列挙

容量の進行状況の状態に対するワークスペースの割り当て。 追加の容量割り当ての進行状況の値は、時間の経過と同時に追加される場合があります。

値 説明
Completed

最後の容量の割り当て操作が正常に完了しました。
Failed

容量の割り当て操作でエラーまたはエラーが発生し、完了できませんでした。
InProgress

容量の割り当て操作は現在実行中であり、まだ完了していません。

CapacityRegion

列挙

このワークスペースに関連付けられている容量のリージョン。 容量リージョンの値は、時間の経過と同時に追加される場合があります。

値 説明
Australia East

オーストラリア東部リージョン
Australia Southeast

オーストラリア南東部リージョン
Brazil South

ブラジル南部リージョン
Brazil Southeast

ブラジル南東部リージョン
Canada Central

カナダ中部リージョン
Canada East

カナダ東部リージョン
Central India

インド中部リージョン
Central US

米国中部リージョン
Central US EUAP

米国中部 EUAP リージョン
East Asia

東アジアリージョン
East US

米国東部リージョン
East US 2

米国東部 2 リージョン
France Central

フランス中部リージョン
France South

フランス南部リージョン
Germany Central

ドイツ中部リージョン
Germany Northeast

ドイツ北東部
Israel Central

イスラエル中部リージョン
Italy North

イタリア北部リージョン
Japan East

東日本リージョン
Japan West

西日本リージョン
Korea Central

韓国中部リージョン
Korea South

韓国南部リージョン
Mexico Central

メキシコ中部リージョン
North Central US

米国中北部リージョン
North Europe

北ヨーロッパリージョン
Norway East

ノルウェー東部リージョン
Norway West

ノルウェー西部リージョン
Poland Central

ポーランド中部リージョン
South Africa North

南アフリカ北部リージョン
South Africa West

南アフリカ西部リージョン
South Central US

米国中南部リージョン
South India

インド南部リージョン
Southeast Asia

東南アジアリージョン
Spain Central

スペイン中部リージョン
Sweden Central

スウェーデン中部リージョン
Switzerland North

スイス北部リージョン
Switzerland West

スイス西部リージョン
West Europe

西ヨーロッパ リージョン
West India

インド西部リージョン
West US

米国西部リージョン
West US 2

米国西部 2 リージョン
West US 3

米国西部 3 リージョン
West Central US

米国中西部リージョン
UAE Central

アラブ首長国連邦中部リージョン
UAE North

アラブ首長国連邦北部リージョン
Qatar Central

カタール中部リージョン
Germany West Central

ドイツ中西部リージョン
Germany North

ドイツ北部リージョン
UK South

英国南部リージョン
UK West

英国西部リージョン
China North

中国北部リージョン
China East

中国東部リージョン
China East 2

中国東部 2 リージョン
China East 3

中国東部 3 リージョン
China North 2

中国北部 2 リージョン
China North 3

中国北部 3 地域

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

エラー関連のリソースの詳細。

OneLakeEndpoints

Object

このワークスペースに関連付けられている OneLake API エンドポイント。

名前 型 説明
blobEndpoint

string

BLOB API 操作で使用できる OneLake API エンドポイント。 既定では、これはリージョン固有のエンドポイントです。 ユーザーが preferWorkspaceSpecificEndpoints を有効にした場合、またはワークスペースにパブリック アクセスが無効になっている場合は、プライベート リンク経由でアクセスできるようにワークスペース固有のエンドポイントが提供されます。
dfsEndpoint

string

分散ファイル システム (DFS) または ADLSgen2 ファイルシステム API 操作で使用できる OneLake API エンドポイント。 既定では、これはリージョン固有のエンドポイントです。 ユーザーが preferWorkspaceSpecificEndpoints を有効にした場合、またはワークスペースにパブリック アクセスが無効になっている場合は、プライベート リンク経由でアクセスできるようにワークスペース固有のエンドポイントが提供されます。

WorkspaceIdentity

Object

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

名前 型 説明
applicationId

string

アプリケーション ID。
servicePrincipalId

string

サービス プリンシパル ID。

WorkspaceInfo

Object

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

名前 型 説明
apiEndpoint

string (uri)

ワークスペースに固有の API エンドポイントを表す HTTP URL。 このエンドポイント値は、ユーザーが preferWorkspaceSpecificEndpoints を有効にすると返されます。 これにより、プライベート リンク経由で API にアクセスできます。
capacityAssignmentProgress

CapacityAssignmentProgress

ワークスペースの容量割り当ての進行状況の状態。
capacityId

string (uuid)

ワークスペースが割り当てられている容量の ID。
capacityRegion

CapacityRegion

このワークスペースに関連付けられている容量のリージョン。
description

string

ワークスペースの説明。
displayName

string

ワークスペースの表示名。
domainId

string (uuid)

ワークスペースが割り当てられているドメインの ID。
id

string (uuid)

ワークスペース ID。
oneLakeEndpoints

OneLakeEndpoints

このワークスペースに関連付けられている OneLake API エンドポイント。
type

WorkspaceType

ワークスペースの種類。
workspaceIdentity

WorkspaceIdentity

ワークスペース ID。

WorkspaceType

列挙

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

値 説明
Personal

ユーザーアイテムの管理に使用するマイ フォルダーまたはマイ ワークスペース。
Workspace

Fabric アイテムの管理に使用されるワークスペース。
AdminWorkspace

管理者監視ワークスペース。 監査レポートや使用状況と導入レポートなどの管理者レポートが含まれます。