Datasets - Discover Gateways In Group
指定したワークスペースから指定したデータセットにバインドできるゲートウェイの一覧を返します。
この API 呼び出しは、少なくとも 1 つのオンプレミス接続を持つデータセットにのみ関連します。 クラウドのみの接続を持つデータセットの場合、この API 呼び出しは空のリストを返します。
アクセス許可
この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedのサービス プリンシパル プロファイル」を参照してください。
必要なスコープ
Dataset.Read.All
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/Default.DiscoverGateways
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
dataset
|
path | True |
string |
データセット ID |
group
|
path | True |
string uuid |
ワークスペース ID |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
例
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.DiscoverGateways
Sample Response
{
"value": [
{
"id": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
"name": "My_Sample_Gateway",
"type": "Resource",
"publicKey": {
"exponent": "AQAB",
"modulus": "o6j2....cLk="
}
}
]
}
定義
名前 | 説明 |
---|---|
Gateway |
Power BI ゲートウェイ |
Gateway |
Power BI ゲートウェイの公開キー |
Gateways |
Power BI ゲートウェイの一覧の OData 応答ラッパー |
Gateway
Power BI ゲートウェイ
名前 | 型 | 説明 |
---|---|---|
gatewayAnnotation |
string |
JSON 形式のゲートウェイ メタデータ |
gatewayStatus |
string |
ゲートウェイの接続状態 |
id |
string |
ゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイ クラスター ID と似ています。 |
name |
string |
ゲートウェイ名 |
publicKey |
ゲートウェイの公開キー |
|
type |
string |
ゲートウェイの種類 |
GatewayPublicKey
Power BI ゲートウェイの公開キー
名前 | 型 | 説明 |
---|---|---|
exponent |
string |
公開キー指数 |
modulus |
string |
公開キーの剰余 |
Gateways
Power BI ゲートウェイの一覧の OData 応答ラッパー
名前 | 型 | 説明 |
---|---|---|
odata.context |
string |
|
value |
Gateway[] |
ゲートウェイの一覧 |