Datasets - Update Parameters

Service:

Power BI REST APIs

API Version:

v1.0

[マイ ワークスペース] から、指定したデータセットのパラメーター値を更新します。

注意

この API 呼び出しで 拡張データセット メタデータ を使用することをお勧めします。

重要

• 拡張データセット メタデータを使用している場合は、データセットを更新して新しいパラメーター値を適用します。
• 拡張データセット メタデータを使用していない場合は、データ ソースの更新操作が完了するまで 30 分待ってから、データセットを更新します。

アクセス許可

ユーザーはデータセット所有者である必要があります。

必要なスコープ

Dataset.ReadWrite.All

制限事項

• パブリック XMLA エンドポイント を使用して作成または変更されたデータセットはサポートされていません。 これらのデータセットを変更するには、管理者が表形式オブジェクト モデルのAzure Analysis Services クライアント ライブラリを使用する必要があります。
• DirectQuery 接続は、 拡張データセット メタデータでのみサポートされます。
• Azure Analysis Servicesライブ接続を持つデータセットはサポートされていません。
• 要求あたり最大 100 個のパラメーター。
• 指定されたすべてのパラメーターは、データセット内に存在する必要があります。
• パラメーターの値は、想定される型である必要があります。
• パラメーター リストを空にしたり、重複するパラメーターを含めたりすることはできません。
• パラメーター名では大文字と小文字が区別されます。
• パラメーター IsRequired には空以外の値が必要です。
• パラメーターの型 Any と Binary は更新できません。
  
  

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/Default.UpdateParameters

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID

要求本文

名前	必須	型	説明
updateDetails	True	UpdateMashupParameterDetails[]	更新するデータセット パラメーターの一覧

応答

名前	型	説明
200 OK		OK

例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.UpdateParameters

Request Body

{
  "updateDetails": [
    {
      "name": "DatabaseName",
      "newValue": "NewDB"
    },
    {
      "name": "MaxId",
      "newValue": "5678"
    }
  ]
}

Sample Response

Status code:

200

定義

名前	説明
UpdateMashupParameterDetails	Power BI データセット パラメーターの更新の詳細
UpdateMashupParametersRequest	Power BI データセット パラメーターの更新要求

UpdateMashupParameterDetails

Power BI データセット パラメーターの更新の詳細

名前	型	説明
name	string	パラメーター名
newValue	string	パラメーターの新しい値

UpdateMashupParametersRequest

Power BI データセット パラメーターの更新要求

名前	型	説明
updateDetails	UpdateMashupParameterDetails[]	更新するデータセット パラメーターの一覧