Items - List Warehouses

サービス:

Warehouse

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}/warehouses

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

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

URI パラメーター

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

応答

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

例

List warehouses in workspace example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Warehouse Name 1",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-09-28T22:52:13.78",
        "lastUpdatedTime": "2023-10-04T22:56:33.283",
        "collationType": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
      }
    },
    {
      "id": "6281bf94-81b9-46b2-b8d3-79bb868fc822",
      "displayName": "Warehouse Name 2",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-11-21T13:14:30.54",
        "lastUpdatedTime": "2023-12-04T20:03:43.110",
        "collationType": "Latin1_General_100_BIN2_UTF8"
      }
    }
  ]
}

定義

名前	説明
CollationType	ウェアハウスの照合順序。 追加の collations は、時間の経過と伴って追加される場合があります。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemType	アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。
Warehouse	ウェアハウス オブジェクト。
WarehouseProperties	倉庫アイテムのプロパティ。
Warehouses	倉庫の一覧。

CollationType

列挙

ウェアハウスの照合順序。 追加の collations は、時間の経過と伴って追加される場合があります。

値	説明
Latin1_General_100_BIN2_UTF8	既定 - 大文字と小文字を区別する (CS) 照合順序
Latin1_General_100_CI_AS_KS_WS_SC_UTF8	大文字と小文字を区別しない (CI) 照合順序

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

ItemType

列挙

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

値	説明
Dashboard	PowerBI ダッシュボード。
DataPipeline	データ パイプライン。
Datamart	PowerBI データマート。
Environment	環境。
Eventhouse	イベントハウス。
Eventstream	イベントストリーム。
GraphQLApi	GraphQL 項目の API。
KQLDashboard	KQL ダッシュボード。
KQLDatabase	KQL データベース。
KQLQueryset	KQL クエリセット。
Lakehouse	レイクハウス。
MLExperiment	機械学習の実験。
MLModel	機械学習モデル。
MirroredDatabase	ミラー化されたデータベース。
MirroredWarehouse	ミラー化された倉庫。
MountedDataFactory	MountedDataFactory。
Notebook	ノートブック。
PaginatedReport	PowerBI のページ分割されたレポート。
Reflex	反射。
Report	PowerBI レポート。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL エンドポイント。
SemanticModel	PowerBI セマンティック モデル。
SparkJobDefinition	Spark ジョブ定義。
Warehouse	倉庫。

Warehouse

Object

ウェアハウス オブジェクト。

名前	型	説明
description	string	アイテムの説明。
displayName	string	アイテムの表示名。
id	string uuid	アイテム ID。
properties	WarehouseProperties	倉庫のプロパティ。
type	ItemType	アイテムの種類。
workspaceId	string uuid	ワークスペース ID。

WarehouseProperties

Object

倉庫アイテムのプロパティ。

名前	型	説明
collationType	CollationType	ウェアハウスの照合順序の種類。
connectionString	string	このウェアハウスを含むワークスペースに接続されている SQL 接続文字列。
createdDate	string date-time	倉庫が作成された日付と時刻。
lastUpdatedTime	string date-time	倉庫が最後に更新された日時

Warehouses

Object

倉庫の一覧。

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