Pipelines - Selective Deploy

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

Nasadí zadané položky ze zdrojové fáze zadaného kanálu nasazení.

Povolení

Uživatel musí být alespoň přispěvatelem v pracovních prostorech zdrojového i cílového nasazení. Další informace najdete v tématu Oprávnění.

Požadovaný obor

Pipeline.Deploy

Omezení

Maximálně 300 nasazených položek na požadavek.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
pipelineId	path	True	string (uuid)	ID kanálu nasazení

Text požadavku

Name	Vyžadováno	Typ	Description
sourceStageOrder	True	integer	Číselný identifikátor fáze nasazení kanálu, ze které má být obsah nasazen. Vývoj (0), Test (1), Výroba (2).
dashboards		DeployArtifactRequest[]	Seznam řídicích panelů, které se mají nasadit
dataflows		DeployArtifactRequest[]	Seznam toků dat, které se mají nasadit
datamarts		DeployArtifactRequest[]	Seznam datových diagramů, které se mají nasadit
datasets		DeployArtifactRequest[]	Seznam datových sad, které se mají nasadit
isBackwardDeployment		boolean	Jestli bude nasazení z pozdější fáze v kanálu nasazení, do dřívější fáze. Výchozí hodnota je `false`.
newWorkspace		PipelineNewWorkspaceRequest	Podrobnosti o konfiguraci pro vytvoření nového pracovního prostoru. Vyžaduje se při nasazování do fáze, která nemá přiřazené žádné přiřazené pracovní prostory. Nasazení selže, pokud nejsou v případě potřeby k dispozici podrobnosti o konfiguraci nového pracovního prostoru.
note		string	Poznámka popisující nasazení
options		DeploymentOptions	Možnosti, které řídí chování celého nasazení
reports		DeployArtifactRequest[]	Seznam sestav, které se mají nasadit
updateAppSettings		PipelineUpdateAppSettings	Aktualizace aplikace organizace v nastavení cílového pracovního prostoru

Odpovědi

Name	Typ	Description
202 Accepted	PipelineOperation	Přijal

Příklady

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

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 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
    }
  ]
}

Definice

Name	Description
DeployArtifactRequest	Žádost o nasazení položky Power BI (například sestavy nebo řídicího panelu)
DeploymentError	Podrobnosti o chybě kroku nasazení
DeploymentExecutionPlan	Plán spuštění nasazení
DeploymentExecutionStep	Krok spuštění nasazení
DeploymentExecutionStepPreDeploymentDiffState	Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.
DeploymentOptions	Možnosti konfigurace nasazení Můžete zadat buď pro celé nasazení, nebo pro konkrétní položku Power BI (například sestavu nebo řídicí panel). Pokud jsou zadány obě možnosti, použijí se jenom možnosti nasazení pro položku Power BI.
DeploymentSourceAndTarget	Zdrojové a cílové položky
DeploymentStepType	Typ kroku nasazení
PipelineNewWorkspaceRequest	Podrobnosti o konfiguraci pro vytvoření nového pracovního prostoru. Vyžaduje se při nasazování do fáze, která nemá přiřazené žádné přiřazené pracovní prostory.
PipelineOperation	Operace kanálu nasazení Power BI
PipelineOperationNote	Poznámka popisující nasazení
PipelineOperationStatus	Stav operace kanálu
PipelineOperationType	Typ operace
PipelineOperationUser	Uživatel nebo instanční objekt, který provedl operaci kanálu.
PipelineUpdateAppSettings	Aktualizace konfigurace aplikace organizace po nasazení
PreDeploymentDiffInformation	Množství nových, různých a identických nasazených položek před nasazením
PrincipalType	Typ objektu zabezpečení
SelectiveDeployRequest	Požadavek na selektivní nasazení položek z fáze kanálu nasazení

DeployArtifactRequest

Objekt

Žádost o nasazení položky Power BI (například sestavy nebo řídicího panelu)

Name	Typ	Description
options	DeploymentOptions	Možnosti konfigurace nasazení pro konkrétní položku Power BI (například sestavu nebo řídicí panel)
sourceId	string (uuid)	ID položky Power BI (například sestavy nebo řídicího panelu), které se má nasadit

DeploymentError

Objekt

Podrobnosti o chybě kroku nasazení

Name	Typ	Description
errorCode	string	Kód chyby
errorDetails	string	Další podrobnosti o chybě

DeploymentExecutionPlan

Objekt

Plán spuštění nasazení

Name	Typ	Description
steps	DeploymentExecutionStep[]	Kolekce kroků plánu provádění

DeploymentExecutionStep

Objekt

Krok spuštění nasazení

Name	Typ	Description
error	DeploymentError	Podrobnosti o chybě. Platí pouze v případě, že operace kanálu selhala.
index	integer	Index kroku
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.
sourceAndTarget	DeploymentSourceAndTarget	Zdrojová a cílová položka kroku
status	PipelineOperationStatus	Stav operace kanálu
type	DeploymentStepType	Typ kroku nasazení

DeploymentExecutionStepPreDeploymentDiffState

Výčet

Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.

Hodnota	Description
New	Nová nasazená položka, která v cílové fázi neexistuje.
Different	Před nasazením nebyla položka ve zdrojové fázi stejná jako položka v cílové fázi.
NoDifference	Před nasazením byla položka ve zdrojové fázi stejná jako položka v cílové fázi.

DeploymentOptions

Objekt

Možnosti konfigurace nasazení Můžete zadat buď pro celé nasazení, nebo pro konkrétní položku Power BI (například sestavu nebo řídicí panel). Pokud jsou zadány obě možnosti, použijí se jenom možnosti nasazení pro položku Power BI.

Name	Typ	Description
allowCreateArtifact	boolean	Bez ohledu na to, jestli je v pracovním prostoru cílové fáze povolené vytváření nové položky Power BI (například sestavy nebo řídicího panelu). Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.
allowOverwriteArtifact	boolean	Ať už je povolené přepsání položky Power BI (například sestavy nebo řídicího panelu) v pracovním prostoru cílové fáze. Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.
allowOverwriteTargetArtifactLabel	boolean	Určuje, jestli je možné změnit popisek cílové položky Power BI (například sestavy nebo řídicího panelu). Popisek se změní, když je zdroj chráněný, ale cíl není. Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.
allowPurgeData	boolean	Jestli chcete odstranit všechna data z cílové položky Power BI (například sestavy nebo řídicího panelu), pokud dojde k neshodě schématu. Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.
allowSkipTilesWithMissingPrerequisites	boolean	Jestli chcete přeskočit dlaždice, které nemají model nebo sestavu v pracovním prostoru cílové fáze. Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.
allowTakeOver	boolean	Zda chcete povolit přepsání předchozího vlastníka stránkované sestavy a stát se vlastníkem stránkované sestavy. Platí pro nasazení stránkované sestavy do fáze, která už obsahuje kopii stránkované sestavy, kterou nevlastníte. Pokud tato možnost není nastavená, `true` když je potřeba pro nasazení, nasazení se nezdaří.

DeploymentSourceAndTarget

Objekt

Zdrojové a cílové položky

Name	Typ	Description
source	string (uuid)	ID položky Power BI nasazené ze zdrojové fáze
sourceDisplayName	string	Zobrazovaný název položky Power BI nasazené ze zdrojové fáze
target	string (uuid)	ID položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.
targetDisplayName	string	Název položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.
type	string	Typ položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.

DeploymentStepType

Výčet

Typ kroku nasazení

Hodnota	Description
DatasetDeployment	Krok pro nasazení jedné datové sady
ReportDeployment	Krok pro nasazení jedné sestavy
DashboardDeployment	Krok pro nasazení jednoho řídicího panelu
DataflowDeployment	Krok pro nasazení jednoho toku dat
DatamartDeployment	Krok pro nasazení jednoho datového diagramu

PipelineNewWorkspaceRequest

Objekt

Podrobnosti o konfiguraci pro vytvoření nového pracovního prostoru. Vyžaduje se při nasazování do fáze, která nemá přiřazené žádné přiřazené pracovní prostory.

Name	Typ	Description
capacityId	string (uuid)	ID kapacity, ke které bude nový pracovní prostor přiřazen. Pokud není zadáno a volající rozhraní API má oprávnění pro kapacitu pracovního prostoru zdrojové fáze, použije se tato kapacita. Jinak Power BI vybere kapacitu, pro kterou má volající rozhraní API oprávnění.
name	string	Název nového pracovního prostoru

PipelineOperation

Objekt

Operace kanálu nasazení Power BI

Name	Typ	Description
executionEndTime	string (date-time)	Datum a čas ukončení operace
executionPlan	DeploymentExecutionPlan	Plán spuštění nasazení. Platí pouze pro jednu operaci kanálu.
executionStartTime	string (date-time)	Datum a čas, kdy byla operace spuštěna
id	string (uuid)	ID operace
lastUpdatedTime	string (date-time)	Datum a čas poslední aktualizace operace
note	PipelineOperationNote	Poznámka představující popis operace.
performedBy	PipelineOperationUser	Uživatel nebo instanční objekt, který provedl operaci kanálu.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Množství nasazených položek ve zdrojové fázi, které jsou nové, identické nebo jiné než položky v cílové fázi, před nasazením.
sourceStageOrder	integer	Číselný identifikátor fáze nasazení zdrojového kanálu. Vývoj (0), Test (1), Výroba (2).
status	PipelineOperationStatus	Stav operace kanálu
targetStageOrder	integer	Číselný identifikátor fáze nasazení cílového kanálu. Vývoj (0), Test (1), Výroba (2).
type	PipelineOperationType	Typ operace

PipelineOperationNote

Objekt

Poznámka popisující nasazení

Name	Typ	Description
content	string	Text popisující nasazení
isTruncated	boolean	Označuje, jestli je poznámka neúplná. Pravda, vrátí se pouze část poznámky. Nepravda, poznámka je hotová.

PipelineOperationStatus

Výčet

Stav operace kanálu

Hodnota	Description
NotStarted	Operace se nespustila
Executing	Provádění operace
Succeeded	Operace byla úspěšná.
Failed	Operace selhala.

PipelineOperationType

Výčet

Typ operace

Hodnota	Description
Deploy	Nasazení obsahu mezi fázemi

PipelineOperationUser

Objekt

Uživatel nebo instanční objekt, který provedl operaci kanálu.

Name	Typ	Description
principalObjectID	string (uuid)	ID instančního objektu, který provedl nasazení.
principalType	PrincipalType	Typ uživatele, který provedl nasazení.
userPrincipalName	string	Hlavní název uživatele( UPN) uživatele, který provedl nasazení

PipelineUpdateAppSettings

Objekt

Aktualizace konfigurace aplikace organizace po nasazení

Name	Typ	Description
updateAppInTargetWorkspace	boolean	Určuje, jestli se má aplikace aktualizovat v cílovém pracovním prostoru. Aktualizují se jenom nasazené položky, které už v aplikaci existují. Do aplikace se nepřidají nové nasazené položky.

PreDeploymentDiffInformation

Objekt

Množství nových, různých a identických nasazených položek před nasazením

Name	Typ	Description
differentArtifactsCount	integer	Počet nasazených položek s rozdíly mezi zdrojovými a cílovými fázemi před nasazením
newArtifactsCount	integer	Počet nových položek nasazených do cílové fáze
noDifferenceArtifactsCount	integer	Počet identických nasazených položek ve zdrojové a cílové fázi před nasazením

PrincipalType

Výčet

Typ objektu zabezpečení

Hodnota	Description
None	Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.
User	Typ objektu zabezpečení uživatele
Group	Typ objektu zabezpečení skupiny
App	Typ instančního objektu

SelectiveDeployRequest

Objekt

Požadavek na selektivní nasazení položek z fáze kanálu nasazení

Name	Typ	Description
dashboards	DeployArtifactRequest[]	Seznam řídicích panelů, které se mají nasadit
dataflows	DeployArtifactRequest[]	Seznam toků dat, které se mají nasadit
datamarts	DeployArtifactRequest[]	Seznam datových diagramů, které se mají nasadit
datasets	DeployArtifactRequest[]	Seznam datových sad, které se mají nasadit
isBackwardDeployment	boolean	Jestli bude nasazení z pozdější fáze v kanálu nasazení, do dřívější fáze. Výchozí hodnota je `false`.
newWorkspace	PipelineNewWorkspaceRequest	Podrobnosti o konfiguraci pro vytvoření nového pracovního prostoru. Vyžaduje se při nasazování do fáze, která nemá přiřazené žádné přiřazené pracovní prostory. Nasazení selže, pokud nejsou v případě potřeby k dispozici podrobnosti o konfiguraci nového pracovního prostoru.
note	string	Poznámka popisující nasazení
options	DeploymentOptions	Možnosti, které řídí chování celého nasazení
reports	DeployArtifactRequest[]	Seznam sestav, které se mají nasadit
sourceStageOrder	integer	Číselný identifikátor fáze nasazení kanálu, ze které má být obsah nasazen. Vývoj (0), Test (1), Výroba (2).
updateAppSettings	PipelineUpdateAppSettings	Aktualizace aplikace organizace v nastavení cílového pracovního prostoru

Sdílet prostřednictvím

Pipelines - Selective Deploy

Povolení

Požadovaný obor

Omezení

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

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

Ukázkový požadavek

Ukázková odpověď

Example of deploying specific Power BI items with custom options

Ukázkový požadavek

Ukázková odpověď

Definice

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest