Pipelines - Selective Deploy

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Stellt die angegebenen Elemente aus der Quellphase der angegebenen Bereitstellungspipeline bereit.

Berechtigungen

Der Benutzer muss mindestens Mitglied in Quell- und Zielbereitstellungsarbeitsbereichen sein. Weitere Informationen finden Sie unter Berechtigungen.

Erforderlicher Bereich

Pipeline.Deploy

Einschränkungen

Maximal 300 bereitgestellte Elemente pro Anforderung.

POST https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/deploy

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
pipelineId	path	True	string uuid	Die Bereitstellungspipeline-ID

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
sourceStageOrder	True	integer	Der numerische Bezeichner der Pipelinebereitstellungsphase, aus der der Inhalt bereitgestellt werden soll. Entwicklung (0), Test (1), Produktion (2).
dashboards		DeployArtifactRequest[]	Eine Liste der bereitzustellenden Dashboards
dataflows		DeployArtifactRequest[]	Eine Liste der bereitzustellenden Dataflows
datamarts		DeployArtifactRequest[]	Eine Liste der bereitzustellenden Datamarts
datasets		DeployArtifactRequest[]	Eine Liste der bereitzustellenden Datasets
isBackwardDeployment		boolean	Gibt an, ob die Bereitstellung von einer späteren Phase in der Bereitstellungspipeline bis zu einer früheren Phase erfolgt. Standardwert: `false`.
newWorkspace		PipelineNewWorkspaceRequest	Die Konfigurationsdetails zum Erstellen eines neuen Arbeitsbereichs. Erforderlich bei der Bereitstellung in einer Phase ohne zugewiesene Arbeitsbereiche. Die Bereitstellung schlägt fehl, wenn die neuen Arbeitsbereichskonfigurationsdetails bei Bedarf nicht angegeben werden.
note		string	Ein Hinweis, der die Bereitstellung beschreibt.
options		DeploymentOptions	Optionen, die das Verhalten der gesamten Bereitstellung steuern
reports		DeployArtifactRequest[]	Eine Liste der bereitzustellenden Berichte
updateAppSettings		PipelineUpdateAppSettings	Aktualisieren der Organisations-App in den Zielarbeitsbereichseinstellungen

Antworten

Name	Typ	Beschreibung
202 Accepted	PipelineOperation	Zulässig

Beispiele

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Example of deploying specific Power BI items with custom options

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

Request Body

{
  "sourceStageOrder": 0,
  "dataflows": [
    {
      "sourceId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3"
    }
  ],
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b"
    }
  ],
  "datasets": [
    {
      "sourceId": "1a201f2a-d1d8-45c0-8c61-1676338517de"
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7"
    }
  ],
  "dashboards": [
    {
      "sourceId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82"
    },
    {
      "sourceId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b"
    }
  ],
  "options": {
    "allowOverwriteArtifact": true,
    "allowCreateArtifact": true
  },
  "note": "Deploying business ready items"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}

Example of deploying specific Power BI items with custom options

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

Request Body

{
  "sourceStageOrder": 0,
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "options": {
        "allowOverwriteArtifact": true,
        "allowCreateArtifact": true
      }
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "options": {
        "allowOverwriteArtifact": true
      }
    }
  ],
  "note": "Deploying business ready items"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}

Definitionen

Name	Beschreibung
DeployArtifactRequest	Eine Anforderung zum Bereitstellen eines Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
DeploymentError	Fehlerdetails für den Bereitstellungsschritt
DeploymentExecutionPlan	Ein Bereitstellungsausführungsplan
DeploymentExecutionStep	Ein Bereitstellungsausführungsschritt
DeploymentExecutionStepPreDeploymentDiffState	Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.
DeploymentOptions	Konfigurationsoptionen für die Bereitstellung. Kann entweder für die gesamte Bereitstellung oder für ein bestimmtes Power BI-Element (z. B. einen Bericht oder ein Dashboard) angegeben werden. Wenn beides angegeben ist, werden nur die Bereitstellungsoptionen für das Power BI-Element verwendet.
DeploymentSourceAndTarget	Quell- und Zielelemente
DeploymentStepType	Art des Bereitstellungsschritts
PipelineNewWorkspaceRequest	Die Konfigurationsdetails zum Erstellen eines neuen Arbeitsbereichs. Erforderlich bei der Bereitstellung in einer Phase ohne zugewiesene Arbeitsbereiche.
PipelineOperation	Ein Power BI-Bereitstellungspipeline-Vorgang
PipelineOperationNote	Ein Hinweis, der die Bereitstellung beschreibt.
PipelineOperationStatus	Der Pipelinevorgangsstatus
PipelineOperationType	Vorgangstyp
PipelineOperationUser	Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.
PipelineUpdateAppSettings	Konfigurationsupdate der Organisations-App nach der Bereitstellung
PreDeploymentDiffInformation	Die Menge neuer, unterschiedlicher und identischer bereitgestellter Elemente vor der Bereitstellung.
PrincipalType	Der Prinzipaltyp
SelectiveDeployRequest	Anforderung zum selektiven Bereitstellen von Elementen aus einer Bereitstellungspipelinephase

DeployArtifactRequest

Eine Anforderung zum Bereitstellen eines Power BI-Elements (z. B. ein Bericht oder ein Dashboard)

Name	Typ	Beschreibung
options	DeploymentOptions	Die Bereitstellungskonfigurationsoptionen für ein bestimmtes Power BI-Element (z. B. einen Bericht oder ein Dashboard)
sourceId	string	Die ID des zu bereitstellenden Power BI-Elements (z. B. ein Bericht oder ein Dashboard)

DeploymentError

Fehlerdetails für den Bereitstellungsschritt

Name	Typ	Beschreibung
errorCode	string	Den Fehlercode
errorDetails	string	Zusätzliche Fehlerdetails

DeploymentExecutionPlan

Ein Bereitstellungsausführungsplan

Name	Typ	Beschreibung
steps	DeploymentExecutionStep[]	Die Auflistung der Ausführungsplanschritte

DeploymentExecutionStep

Ein Bereitstellungsausführungsschritt

Name	Typ	Beschreibung
error	DeploymentError	Die Fehlerdetails. Gilt nur, wenn beim Pipelinevorgang ein Fehler aufgetreten ist.
index	integer	Der Schrittindex
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.
sourceAndTarget	DeploymentSourceAndTarget	Die Quell- und Zielelemente des Schritts
status	PipelineOperationStatus	Der Status des Pipelinevorgangs
type	DeploymentStepType	Art des Bereitstellungsschritts

DeploymentExecutionStepPreDeploymentDiffState

Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.

Name	Typ	Beschreibung
Different	string	Vor der Bereitstellung war das Element in der Quellphase nicht mit dem Element in der Zielphase identisch.
New	string	Ein neues bereitgestelltes Element, das in der Zielphase nicht vorhanden ist.
NoDifference	string	Vor der Bereitstellung war das Element in der Quellphase mit dem Element in der Zielphase identisch.

DeploymentOptions

Konfigurationsoptionen für die Bereitstellung. Kann entweder für die gesamte Bereitstellung oder für ein bestimmtes Power BI-Element (z. B. einen Bericht oder ein Dashboard) angegeben werden. Wenn beides angegeben ist, werden nur die Bereitstellungsoptionen für das Power BI-Element verwendet.

Name	Typ	Beschreibung
allowCreateArtifact	boolean	Gibt an, ob das Erstellen eines neuen Power BI-Elements (z. B. ein Bericht oder ein Dashboard) im Arbeitsbereich der Zielphase zulässig ist. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.
allowOverwriteArtifact	boolean	Gibt an, ob das Überschreiben eines Power BI-Elements (z. B. ein Bericht oder ein Dashboard) im Arbeitsbereich der Zielphase zulässig ist. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.
allowOverwriteTargetArtifactLabel	boolean	Gibt an, ob die Bezeichnung eines Power BI-Zielelements (z. B. ein Bericht oder ein Dashboard) geändert werden kann. Die Bezeichnung wird geändert, wenn die Quelle geschützt ist, aber das Ziel nicht. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.
allowPurgeData	boolean	Gibt an, ob alle Daten aus dem Power BI-Zielelement (z. B. ein Bericht oder ein Dashboard) gelöscht werden sollen, wenn ein Schemakonflikt vorliegt. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.
allowSkipTilesWithMissingPrerequisites	boolean	Gibt an, ob Kacheln ohne Modell oder Bericht im Arbeitsbereich der Zielphase übersprungen werden sollen. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.
allowTakeOver	boolean	Gibt an, ob das Überschreiben des vorherigen paginierten Berichtsbesitzers und der Besitzer des paginierten Berichts zugelassen werden soll. Anwendbar beim Bereitstellen eines paginierten Berichts in einer Phase, die bereits eine Kopie des paginierten Berichts enthält, der nicht Im Besitz Von Ihnen ist. Wenn diese Option nicht auf `true` festgelegt ist, wenn sie für die Bereitstellung erforderlich ist, schlägt die Bereitstellung fehl.

DeploymentSourceAndTarget

Quell- und Zielelemente

Name	Typ	Beschreibung
source	string	Die ID des Power BI-Elements, das aus der Quellphase bereitgestellt wird
sourceDisplayName	string	Der Anzeigename des Power BI-Elements, das in der Quellphase bereitgestellt wird
target	string	Die ID des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.
targetDisplayName	string	Der Name des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.
type	string	Der Typ des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.

DeploymentStepType

Art des Bereitstellungsschritts

Name	Typ	Beschreibung
DashboardDeployment	string	Ein Schritt für die Bereitstellung eines einzelnen Dashboards
DataflowDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Dataflows
DatamartDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen datamart
DatasetDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Datasets
ReportDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Berichts

PipelineNewWorkspaceRequest

Die Konfigurationsdetails zum Erstellen eines neuen Arbeitsbereichs. Erforderlich bei der Bereitstellung in einer Phase ohne zugewiesene Arbeitsbereiche.

Name	Typ	Beschreibung
capacityId	string	Die ID der Kapazität, der der neue Arbeitsbereich zugewiesen wird. Wenn nicht angegeben ist und der API-Aufrufer Über Berechtigungen für die Kapazität des Quellarbeitsbereichs verfügt, wird diese Kapazität verwendet. Andernfalls wählt Power BI eine Kapazität aus, für die der API-Aufrufer Berechtigungen besitzt.
name	string	Der Name des neuen Arbeitsbereichs

PipelineOperation

Ein Power BI-Bereitstellungspipeline-Vorgang

Name	Typ	Beschreibung
executionEndTime	string	Datum und Uhrzeit des Vorgangsendes
executionPlan	DeploymentExecutionPlan	Der Bereitstellungsausführungsplan. Gilt nur für einen einzelnen Pipelinevorgang.
executionStartTime	string	Datum und Uhrzeit des Startvorgangs
id	string	Die Vorgangs-ID
lastUpdatedTime	string	Datum und Uhrzeit der letzten Aktualisierung des Vorgangs
note	PipelineOperationNote	Eine Notiz, die eine Beschreibung des Vorgangs darstellt.
performedBy	PipelineOperationUser	Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Die Menge der bereitgestellten Elemente in der Quellphase, die vor der Bereitstellung neu, identisch oder sich von Elementen in der Zielphase unterscheiden.
sourceStageOrder	integer	Der numerische Bezeichner einer Bereitstellungsphase der Quellpipeline. Entwicklung (0), Test (1), Produktion (2).
status	PipelineOperationStatus	Der Pipelinevorgangsstatus
targetStageOrder	integer	Der numerische Bezeichner einer Bereitstellungsphase einer Zielpipeline. Entwicklung (0), Test (1), Produktion (2).
type	PipelineOperationType	Vorgangstyp

PipelineOperationNote

Ein Hinweis, der die Bereitstellung beschreibt.

Name	Typ	Beschreibung
content	string	Text, der die Bereitstellung beschreibt.
isTruncated	boolean	Gibt an, ob die Notiz unvollständig ist. True, nur ein Teil der Notiz wird zurückgegeben. False, die Notiz ist abgeschlossen.

PipelineOperationStatus

Der Pipelinevorgangsstatus

Name	Typ	Beschreibung
Executing	string	Vorgang, der ausgeführt wird
Failed	string	Fehler beim Vorgang
NotStarted	string	Vorgang wurde nicht gestartet
Succeeded	string	Vorgang erfolgreich

PipelineOperationType

Vorgangstyp

Name	Typ	Beschreibung
Deploy	string	Bereitstellen von Inhalten zwischen Phasen

PipelineOperationUser

Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.

Name	Typ	Beschreibung
principalObjectID	string	Die ID des Dienstprinzipals, der die Bereitstellung ausgeführt hat.
principalType	PrincipalType	Der Typ des Benutzers, der die Bereitstellung ausgeführt hat.
userPrincipalName	string	Der UPN des Benutzers, der die Bereitstellung ausgeführt hat.

PipelineUpdateAppSettings

Konfigurationsupdate der Organisations-App nach der Bereitstellung

Name	Typ	Beschreibung
updateAppInTargetWorkspace	boolean	Gibt an, ob die App im Zielarbeitsbereich aktualisiert werden soll. Nur bereitgestellte Elemente, die bereits in der App vorhanden sind, werden aktualisiert. Neue bereitgestellte Elemente werden der App nicht hinzugefügt.

PreDeploymentDiffInformation

Die Menge neuer, unterschiedlicher und identischer bereitgestellter Elemente vor der Bereitstellung.

Name	Typ	Beschreibung
differentArtifactsCount	integer	Die Anzahl der bereitgestellten Elemente mit Unterschieden zwischen Quell- und Zielphasen vor der Bereitstellung.
newArtifactsCount	integer	Die Anzahl der in der Zielphase bereitgestellten neuen Elemente.
noDifferenceArtifactsCount	integer	Die Anzahl identischer bereitgestellter Elemente in der Quell- und Zielphase vor der Bereitstellung.

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.
User	string	Benutzerprinzipaltyp

SelectiveDeployRequest

Anforderung zum selektiven Bereitstellen von Elementen aus einer Bereitstellungspipelinephase

Name	Typ	Beschreibung
dashboards	DeployArtifactRequest[]	Eine Liste der bereitzustellenden Dashboards
dataflows	DeployArtifactRequest[]	Eine Liste der bereitzustellenden Dataflows
datamarts	DeployArtifactRequest[]	Eine Liste der bereitzustellenden Datamarts
datasets	DeployArtifactRequest[]	Eine Liste der bereitzustellenden Datasets
isBackwardDeployment	boolean	Gibt an, ob die Bereitstellung von einer späteren Phase in der Bereitstellungspipeline bis zu einer früheren Phase erfolgt. Standardwert: `false`.
newWorkspace	PipelineNewWorkspaceRequest	Die Konfigurationsdetails zum Erstellen eines neuen Arbeitsbereichs. Erforderlich bei der Bereitstellung in einer Phase ohne zugewiesene Arbeitsbereiche. Die Bereitstellung schlägt fehl, wenn die neuen Arbeitsbereichskonfigurationsdetails bei Bedarf nicht angegeben werden.
note	string	Ein Hinweis, der die Bereitstellung beschreibt.
options	DeploymentOptions	Optionen, die das Verhalten der gesamten Bereitstellung steuern
reports	DeployArtifactRequest[]	Eine Liste der bereitzustellenden Berichte
sourceStageOrder	integer	Der numerische Bezeichner der Pipelinebereitstellungsphase, aus der der Inhalt bereitgestellt werden soll. Entwicklung (0), Test (1), Produktion (2).
updateAppSettings	PipelineUpdateAppSettings	Aktualisieren der Organisations-App in den Zielarbeitsbereichseinstellungen

Freigeben über

Pipelines - Selective Deploy

Berechtigungen

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Anforderungstext

Antworten

Beispiele

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

Sample Response

Example of deploying specific Power BI items with custom options

Sample Request

Sample Response

Definitionen

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Zusätzliche Ressourcen