Items - Bind Semantic Model Connection

サービス:

SemanticModel

API バージョン:

v1

セマンティック モデルのデータ ソース参照をデータ接続にバインドします。
この API を使用して、データ ソース参照のバインドを解除することもできます。

Permissions

呼び出し元はセマンティック モデルの所有者である必要があります。

制限事項

この API は一括操作をサポートしていません。 セマンティック モデルの複数のデータ ソース参照をバインドするには、ユーザーが複数の bindConnection 要求を送信する必要があります。

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

SemanticModel.ReadWrite.All または Item.ReadWrite.All

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

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

アイデンティティ	Support
User	イエス
サービス プリンシパルとマネージド ID	イエス

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/bindConnection

URI パラメーター

名前	/	必須	型	説明
semanticModelId	path	True	string (uuid)	セマンティック モデル ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	必須	型	説明
connectionBinding	True	ConnectionBinding	接続バインドの詳細。

応答

名前	型	説明
200 OK		要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。 ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラー コード: ItemNotFound - 要求されたセマンティック モデルが見つかりませんでした。 InvalidRequest - バインド セマンティック モデル接続要求が無効です。

例

Bind a semantic model connection example

Unbind a semantic model connection example

Bind a semantic model connection example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/bindConnection

{
  "connectionBinding": {
    "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
    "connectivityType": "OnPremisesDataGateway",
    "connectionDetails": {
      "type": "SQL",
      "path": "contoso.database.windows.net;sales"
    }
  }
}

応答のサンプル

状態コード:

200

Unbind a semantic model connection example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/bindConnection

{
  "connectionBinding": {
    "connectivityType": "None",
    "connectionDetails": {
      "type": "SQL",
      "path": "contoso.database.windows.net;sales"
    }
  }
}

応答のサンプル

状態コード:

200

定義

名前	説明
BindSemanticModelConnectionRequest	セマンティック モデルのデータ ソース参照をデータ接続にバインドする bindConnection 要求のペイロード。
ConnectionBinding	接続バインドの詳細。
ConnectivityType	接続の接続の種類。 追加の接続の種類は、時間の経過と同時に追加される場合があります。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ListConnectionDetails	リスト操作の接続の詳細出力。

BindSemanticModelConnectionRequest

Object

セマンティック モデルのデータ ソース参照をデータ接続にバインドする bindConnection 要求のペイロード。

名前	型	説明
connectionBinding	ConnectionBinding	接続バインドの詳細。

ConnectionBinding

Object

接続バインドの詳細。

名前	型	説明
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	ConnectivityType	接続の接続の種類。
id	string (uuid)	接続のオブジェクト ID。

ConnectivityType

列挙

接続の接続の種類。 追加の接続の種類は、時間の経過と同時に追加される場合があります。

値	説明
ShareableCloud	接続はクラウド経由で接続され、他のユーザーと共有できます。
PersonalCloud	接続はクラウド経由で接続され、他のユーザーと共有することはできません。
OnPremisesGateway	接続は、オンプレミスのデータ ゲートウェイを介して接続します。
OnPremisesGatewayPersonal	接続は、個人用のオンプレミス データ ゲートウェイ経由で接続されます。
VirtualNetworkGateway	接続は、仮想ネットワーク データ ゲートウェイを介して接続します。
Automatic	接続は、暗黙的なデータ接続を使用してクラウド経由で接続します。 このオプションは、シングル Sign-On (SSO) を使用するセマンティック モデルなどの特定のシナリオでのみ使用できます。
None	接続がバインドされていません

ErrorRelatedResource

Object

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

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

ListConnectionDetails

Object

リスト操作の接続の詳細出力。

名前	型	説明
path	string	接続のパス。
type	string	接続の種類。