Datasets - Update Parameters In Group
指定したワークスペースから、指定したデータセットのパラメーター値を更新します。
注
この API 呼び出しでは 、拡張データセット メタデータ を使用することをお勧めします。
Important
- 拡張データセット メタデータを使用している場合は、データセットを更新して新しいパラメーター値を適用します。
- 拡張データセット メタデータを使用していない場合は、データ ソースの更新操作が完了するまで 30 分待ってから、データセットを更新します。
Permissions
- ユーザーはデータセット所有者である必要があります。
- この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「 Power BI Embedded のサービス プリンシパル プロファイル」を参照してください。
必要なスコープ
Dataset.ReadWrite.All
制限事項
- パブリック XMLA エンドポイント を使用して作成または変更されたデータセットはサポートされていません。 これらのデータセットを変更するには、管理者が表形式オブジェクト モデルの Azure Analysis Services クライアント ライブラリを使用する必要があります。
- DirectQuery 接続は、 拡張データセット メタデータでのみサポートされます。
- Azure Analysis Services ライブ接続を使用したデータセットはサポートされていません。
- 要求あたり最大 100 個のパラメーター。
- 指定したすべてのパラメーターがデータセットに存在する必要があります。
- パラメーターの値は、想定される型である必要があります。
- パラメーター リストを空にしたり、重複するパラメーターを含めたりすることはできません。
- パラメーター名では大文字と小文字が区別されます。
- パラメーター
IsRequiredには空以外の値が必要です。 - パラメーターの型
AnyとBinaryは更新できません。
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/Default.UpdateParameters
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
dataset
|
path | True |
string |
|
|
group
|
path | True |
string (uuid) |
ワークスペース ID |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| updateDetails | True |
更新するデータセット パラメーターの一覧 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
[OK] |
例
Example
要求のサンプル
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.UpdateParameters
{
"updateDetails": [
{
"name": "DatabaseName",
"newValue": "NewDB"
},
{
"name": "MaxId",
"newValue": "5678"
}
]
}
応答のサンプル
定義
| 名前 | 説明 |
|---|---|
|
Update |
Power BI データセット パラメーターの更新の詳細 |
|
Update |
Power BI データセット パラメーターの更新要求 |
UpdateMashupParameterDetails
Power BI データセット パラメーターの更新の詳細
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
パラメーター名 |
| newValue |
string |
パラメーターの新しい値 |
UpdateMashupParametersRequest
Power BI データセット パラメーターの更新要求
| 名前 | 型 | 説明 |
|---|---|---|
| updateDetails |
更新するデータセット パラメーターの一覧 |