Template Apps - Create Install Ticket

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Generiert ein Installationsticket für den automatisierten Installationsfluss der angegebenen Vorlagen-App.

Berechtigungen

Der Anrufer muss den Dienstprinzipal für die Authentifizierung verwenden. Weitere Informationen finden Sie unter Einbetten von Power BI-Inhalten mit Dienstprinzipal und Überlegungen und Einschränkungen.

Einschränkungen

Der Mandanten, der diesen API-Aufruf macht , muss die angegebene Vorlagen-App besitzen.
Die Vorlagen-App muss entweder in Microsoft AppSource veröffentlicht werden oder sowohl der Ticket-Creator als auch der Endbenutzer, der mit dem Ticket installiert wird, expliziten Zugriff auf die App haben.
Alle Abfrageparameter im Installationsticket müssen konfiguriert werden.

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

Anforderungstext

Name	Typ	Beschreibung
installDetails	TemplateAppInstallDetails[]	Liste der Installationsdetails

Antworten

Name	Typ	Beschreibung
200 OK	InstallTicket	OK

Beispiele

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
    }
  }
}

Definitionen

Name	Beschreibung
CreateInstallTicketRequest	Eine Anforderung zum Erstellen eines Power BI-Installationstickets
InstallTicket	Ein automatisiertes Installationsticket für eine Power BI-Vorlagen-App
TemplateAppConfigurationRequest	Eine automatisierte Installationskonfiguration für eine Power BI-Vorlagen-App (Wörterbuch der Namenswertpaare)
TemplateAppInstallDetails	Die Installationsdetails für eine Power BI-Vorlagen-App

CreateInstallTicketRequest

Eine Anforderung zum Erstellen eines Power BI-Installationstickets

Name	Typ	Beschreibung
installDetails	TemplateAppInstallDetails[]	Liste der Installationsdetails

InstallTicket

Ein automatisiertes Installationsticket für eine Power BI-Vorlagen-App

Name	Typ	Beschreibung
expiration	string	Ablaufdatum und Uhrzeit (UTC) des Tickets
ticket	string	Ticket installieren
ticketId	string	Die eindeutige ID eines Installationstickets. Überwachungsprotokolle können verwendet werden, um Vorgänge zu korrelieren, die dieses Ticket mit dem Generieren des Ticketvorgangs verwenden.

TemplateAppConfigurationRequest

Eine automatisierte Installationskonfiguration für eine Power BI-Vorlagen-App (Wörterbuch der Namenswertpaare)

Name	Typ	Beschreibung
configuration	object

TemplateAppInstallDetails

Die Installationsdetails für eine Power BI-Vorlagen-App

Name	Typ	Beschreibung
appId	string	Die eindeutige ID der Power BI-Vorlagen-App
config	TemplateAppConfigurationRequest	Die automatische Installationskonfiguration
ownerTenantId	string	Die Mandanten-ID des Power BI-Vorlagen-App-Besitzers
packageKey	string	Der sichere Schlüssel für die Power BI-Vorlagen-App-Version