Sdílet prostřednictvím


Pipelines - Selective Deploy

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

Oprávnění

Uživatel musí být alespoň členem zdrojového i cílového pracovního prostoru nasazení. Další informace najdete v tématu Oprávnění.

Požadovaný obor

Pipeline.Deploy

Omezení

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

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é se má obsah nasadit. Vývoj (0), Test (1), Produkce (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 tržiště, která se mají nasadit

datasets

DeployArtifactRequest[]

Seznam datových sad, které se mají nasadit

isBackwardDeployment

boolean

Určuje, jestli nasazení proběhne z pozdější fáze kanálu nasazení do dřívější fáze. Výchozí hodnota je false.

newWorkspace

PipelineNewWorkspaceRequest

Podrobnosti konfigurace pro vytvoření nového pracovního prostoru. Vyžaduje se při nasazení do fáze, která nemá přiřazené žádné pracovní prostory. Nasazení selže, pokud se v případě potřeby nezadá 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řijato

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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy
{
  "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

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

{
  "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ě pro krok 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í Dá se zadat buď pro celé nasazení, nebo pro konkrétní položku Power BI (například sestavu nebo řídicí panel). Pokud jsou zadané obě možnosti, použijí se pouze možnosti nasazení pro položku Power BI.

DeploymentSourceAndTarget

Zdrojové a cílové položky

DeploymentStepType

Typ kroku nasazení

PipelineNewWorkspaceRequest

Podrobnosti konfigurace pro vytvoření nového pracovního prostoru Vyžaduje se při nasazování do fáze, která nemá 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

Žá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

ID položky Power BI (například sestavy nebo řídicího panelu) k nasazení

DeploymentError

Podrobnosti o chybě pro krok nasazení

Name Typ Description
errorCode

string

Kód chyby

errorDetails

string

Další podrobnosti o chybě

DeploymentExecutionPlan

Plán spuštění nasazení

Name Typ Description
steps

DeploymentExecutionStep[]

Kolekce kroků plánu provádění

DeploymentExecutionStep

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žky kroku

status

PipelineOperationStatus

Stav operace kanálu

type

DeploymentStepType

Typ kroku nasazení

DeploymentExecutionStepPreDeploymentDiffState

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

Name Typ Description
Different

string

Před nasazením nebyla položka ve zdrojové fázi shodná s položkou v cílové fázi.

New

string

Nová nasazená položka, která v cílové fázi neexistuje.

NoDifference

string

Před nasazením byla položka ve zdrojové fázi shodná s položkou v cílové fázi.

DeploymentOptions

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

Name Typ Description
allowCreateArtifact

boolean

Jestli je povolené vytváření nové 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á na true dobu, kdy je potřeba pro nasazení, nasazení selže.

allowOverwriteArtifact

boolean

Jestli 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á na true dobu, kdy je potřeba pro nasazení, nasazení selže.

allowOverwriteTargetArtifactLabel

boolean

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á na true dobu, kdy je potřeba pro nasazení, nasazení selže.

allowPurgeData

boolean

Jestli chcete odstranit všechna data z cílové položky Power BI (například sestavy nebo řídicího panelu), když dojde k neshodě schématu. Pokud tato možnost není nastavená na true dobu, kdy je potřeba pro nasazení, nasazení selže.

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á na true dobu, kdy je potřeba pro nasazení, nasazení selže.

allowTakeOver

boolean

Jestli 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 vy. Pokud tato možnost není nastavená na true dobu, kdy je potřeba pro nasazení, nasazení selže.

DeploymentSourceAndTarget

Zdrojové a cílové položky

Name Typ Description
source

string

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

ID položky Power BI, která se v cílové fázi přepíše. Platí jenom při přepsání položky Power BI.

targetDisplayName

string

Název položky Power BI, která se v cílové fázi přepíše. 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

Typ kroku nasazení

Name Typ Description
DashboardDeployment

string

Krok pro nasazení jednoho řídicího panelu

DataflowDeployment

string

Krok pro nasazení jednoho toku dat

DatamartDeployment

string

Krok pro nasazení jednoho datového tržiště

DatasetDeployment

string

Krok pro nasazení jedné datové sady

ReportDeployment

string

Krok pro nasazení jedné sestavy

PipelineNewWorkspaceRequest

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

Name Typ Description
capacityId

string

ID kapacity, ke které bude nový pracovní prostor přiřazen. Pokud není zadáno a volající rozhraní API má oprávnění ke kapacitě pracovního prostoru zdrojové fáze, použije se tato kapacita. Jinak Power BI vybere kapacitu, ke které má volající rozhraní API oprávnění.

name

string

Název nového pracovního prostoru

PipelineOperation

Operace kanálu nasazení Power BI

Name Typ Description
executionEndTime

string

Datum a čas ukončení operace

executionPlan

DeploymentExecutionPlan

Plán spuštění nasazení. Platí pouze pro jednu operaci kanálu.

executionStartTime

string

Datum a čas zahájení operace

id

string

ID operace

lastUpdatedTime

string

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é, stejné nebo odlišné od položek v cílové fázi, před nasazením.

sourceStageOrder

integer

Číselný identifikátor fáze nasazení zdrojového kanálu. Vývoj (0), testování (1), produkce (2).

status

PipelineOperationStatus

Stav operace kanálu

targetStageOrder

integer

Číselný identifikátor fáze nasazení cílového kanálu Vývoj (0), testování (1), produkce (2).

type

PipelineOperationType

Typ operace

PipelineOperationNote

Poznámka popisující nasazení

Name Typ Description
content

string

Text popisující nasazení

isTruncated

boolean

Označuje, jestli je poznámka neúplná. Ano, vrátí se jenom část poznámky. Nepravda, poznámka je dokončená.

PipelineOperationStatus

Stav operace kanálu

Name Typ Description
Executing

string

Provádění operace

Failed

string

Operace se nezdařila

NotStarted

string

Operace se nespustila

Succeeded

string

Operace byla úspěšná.

PipelineOperationType

Typ operace

Name Typ Description
Deploy

string

Nasazení obsahu mezi fázemi

PipelineOperationUser

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

Name Typ Description
principalObjectID

string

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

Aktualizace konfigurace aplikace organizace po nasazení

Name Typ Description
updateAppInTargetWorkspace

boolean

Jestli se má aplikace aktualizovat v cílovém pracovním prostoru. Aktualizují se jenom nasazené položky, které už v aplikaci existují. Nové nasazené položky se do aplikace nepřidají.

PreDeploymentDiffInformation

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 fází zdroje a cíle 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

Typ objektu zabezpečení

Name Typ Description
App

string

Typ instančního objektu

Group

string

Typ objektu zabezpečení skupiny

None

string

Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.

User

string

Typ objektu zabezpečení uživatele

SelectiveDeployRequest

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 konfigurace pro vytvoření nového pracovního prostoru Vyžaduje se při nasazování do fáze, která nemá 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é se má obsah nasadit. Vývoj (0), testování (1), produkce (2).

updateAppSettings

PipelineUpdateAppSettings

Aktualizace aplikace organizace v nastavení cílového pracovního prostoru