Template Apps - Create Install Ticket

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したテンプレートアプリの自動インストールフローのインストールチケットを生成します。

アクセス許可

呼び出し元は、認証にサービスプリンシパルを使用する必要があります。詳細については、「Power BI コンテンツをサービスプリンシパルに埋め込む」と「考慮事項と制限事項」を参照してください。

制限事項

この API 呼び出しを行うテナントは、指定されたテンプレートアプリを所有 している必要があります 。
テンプレートアプリは Microsoft AppSource に発行する必要があります。または、チケット作成者と、チケットを使用してインストールするエンドユーザーの両方が、アプリへの明示的なアクセス権を持っている必要があります。
インストールチケット内のすべてのクエリパラメーターを構成 する必要があります 。

POST https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket

要求本文

名前	型	説明
installDetails	TemplateAppInstallDetails[]	インストールの詳細の一覧

応答

名前	型	説明
200 OK	InstallTicket	OK

例

Create an install ticket for a template app, specifying two query parameters example.

Sample Request

POST https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket

Request Body

{
  "appId": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "packageKey": "g632bb64...OfsoqT56xEM=",
  "ownerTenantId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
  "config": {
    "configuration": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

Sample Response

Status code:: 200

{
  "ticket": "H4sI....AAA=",
  "ticketId": "4b76f5ed-5a06-4150-8d1b-60f8e4c186f4",
  "expiration": "2020-07-29T17:58:19Z"
}

Status code:: 401

{
  "error": {
    "code": "ServiceAppApplicationOwnershipValidationFailed",
    "pbi.error": {
      "code": "ServiceAppApplicationOwnershipValidationFailed",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

Status code:: 400

{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

定義

名前	説明
CreateInstallTicketRequest	Power BI インストールチケットを作成する要求
InstallTicket	Power BI テンプレートアプリの自動インストールチケット
TemplateAppConfigurationRequest	Power BI テンプレートアプリの自動インストール構成 (名前と値のペアのディクショナリ)
TemplateAppInstallDetails	Power BI テンプレートアプリのインストールの詳細

CreateInstallTicketRequest

Power BI インストールチケットを作成する要求

名前	型	説明
installDetails	TemplateAppInstallDetails[]	インストールの詳細の一覧

InstallTicket

Power BI テンプレートアプリの自動インストールチケット

名前	型	説明
expiration	string	チケットの有効期限の日付と時刻 (UTC)
ticket	string	チケットのインストール
ticketId	string	インストールチケットの一意の ID。監査ログを使用して、このチケットを使用する操作をチケット生成操作と関連付けることができます。

TemplateAppConfigurationRequest

Power BI テンプレートアプリの自動インストール構成 (名前と値のペアのディクショナリ)

名前	型	説明
configuration	object

TemplateAppInstallDetails

Power BI テンプレートアプリのインストールの詳細

名前	型	説明
appId	string	Power BI テンプレートアプリの一意の ID
config	TemplateAppConfigurationRequest	自動インストール構成
ownerTenantId	string	Power BI テンプレートアプリ所有者のテナント ID
packageKey	string	Power BI テンプレートアプリバージョンのセキュリティで保護されたキー