次の方法で共有

Items - Get Lakehouse

  • リファレンス
サービス:
Lakehouse
API バージョン:
v1

指定したレイクハウスのプロパティを返します。

権限

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

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

Lakehouse.Read.All または Lakehouse.ReadWrite.All または Item.Read.All または Item.ReadWrite.All

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
lakehouseId
 path True

string

uuid

レイクハウス ID。
workspaceId
 path True

string

uuid

ワークスペース ID。

応答

名前 型 説明
200 OK

Lakehouse

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

ErrorResponse

一般的なエラー コード:

  • ItemNotFound - 要求された項目が見つかりませんでした。

例

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

要求のサンプル

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

応答のサンプル

状態コード:
200 
{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Files",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
      "provisioningStatus": "Success"
    }
  }
}

Get a lakehouse with schema example

要求のサンプル

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

応答のサンプル

状態コード:
200 
{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Files",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
      "provisioningStatus": "Success"
    },
    "defaultSchema": "dbo"
  }
}

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ItemType

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

レイクハウスアイテム。
LakehouseProperties

レイクハウスのプロパティ。
SqlEndpointProperties

SQL エンドポイントのプロパティを含むオブジェクト。
SqlEndpointProvisioningStatus

SQL エンドポイントのプロビジョニング状態の種類。 追加の SqlEndpointProvisioningStatus 型は、時間の経過と同時に追加される場合があります。

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

倉庫。

Lakehouse

Object

レイクハウスアイテム。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
id

string

uuid

アイテム ID。
properties

LakehouseProperties

レイクハウスのプロパティ。
type

ItemType

アイテムの種類。
workspaceId

string

uuid

ワークスペース ID。

LakehouseProperties

Object

レイクハウスのプロパティ。

名前 型 説明
defaultSchema

string

レイクハウスの既定のスキーマ。 このプロパティは、スキーマが有効な lakehouse の場合にのみ返されます。
oneLakeFilesPath

string

Lakehouse ファイル ディレクトリへの OneLake パス。
oneLakeTablesPath

string

Lakehouse テーブル ディレクトリへの OneLake パス。
sqlEndpointProperties

SqlEndpointProperties

SQL エンドポイントのプロパティを含むオブジェクト。

SqlEndpointProperties

Object

SQL エンドポイントのプロパティを含むオブジェクト。

名前 型 説明
connectionString

string

SQL エンドポイント接続文字列。
id

string

SQL エンドポイント ID。
provisioningStatus

SqlEndpointProvisioningStatus

SQL エンドポイントのプロビジョニング状態。

SqlEndpointProvisioningStatus

列挙

SQL エンドポイントのプロビジョニング状態の種類。 追加の SqlEndpointProvisioningStatus 型は、時間の経過と同時に追加される場合があります。

値 説明
Failed

SQL エンドポイントのプロビジョニングに失敗しました。
InProgress

SQL エンドポイントのプロビジョニングが進行中です。
Success

SQL エンドポイントのプロビジョニングに成功しました。