Pipelines - Selective Deploy

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Distribuisce gli elementi specificati dalla fase di origine della pipeline di distribuzione specificata.

Autorizzazioni

L'utente deve almeno essere membro sia nelle aree di lavoro di distribuzione di origine che di destinazione. Per altre informazioni, vedere Autorizzazioni.

Ambito obbligatorio

Pipeline.Deploy

Limitazioni

Massimo 300 elementi distribuiti per richiesta.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
pipelineId	path	True	string uuid	ID della pipeline di distribuzione

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
sourceStageOrder	True	integer	Identificatore numerico della fase di distribuzione della pipeline da cui distribuire il contenuto. Sviluppo (0), Test (1), Produzione (2).
dashboards		DeployArtifactRequest[]	Elenco di dashboard da distribuire
dataflows		DeployArtifactRequest[]	Elenco di flussi di dati da distribuire
datamarts		DeployArtifactRequest[]	Elenco di datamarts da distribuire
datasets		DeployArtifactRequest[]	Elenco di set di dati da distribuire
isBackwardDeployment		boolean	Indica se la distribuzione verrà eseguita da una fase successiva nella pipeline di distribuzione, a una versione precedente. Il valore predefinito è `false`.
newWorkspace		PipelineNewWorkspaceRequest	Dettagli di configurazione per la creazione di una nuova area di lavoro. Obbligatorio quando si esegue la distribuzione in una fase senza aree di lavoro assegnate. La distribuzione avrà esito negativo se i dettagli di configurazione della nuova area di lavoro non vengono forniti quando necessario.
note		string	Nota che descrive la distribuzione.
options		DeploymentOptions	Opzioni che controllano il comportamento dell'intera distribuzione
reports		DeployArtifactRequest[]	Elenco di report da distribuire
updateAppSettings		PipelineUpdateAppSettings	Aggiornare l'app dell'organizzazione nelle impostazioni dell'area di lavoro di destinazione

Risposte

Nome	Tipo	Descrizione
202 Accepted	PipelineOperation	Accettato

Esempio

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

Definizioni

Nome	Descrizione
DeployArtifactRequest	Richiesta di distribuzione di un elemento di Power BI , ad esempio un report o un dashboard
DeploymentError	Dettagli dell'errore per il passaggio di distribuzione
DeploymentExecutionPlan	Un piano di esecuzione della distribuzione
DeploymentExecutionStep	Passaggio di esecuzione della distribuzione
DeploymentExecutionStepPreDeploymentDiffState	Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione.
DeploymentOptions	Opzioni di configurazione della distribuzione. Può essere specificato per l'intera distribuzione o per un elemento di Power BI specifico, ad esempio un report o un dashboard. Se vengono specificati entrambi, vengono usate solo le opzioni di distribuzione per l'elemento di Power BI.
DeploymentSourceAndTarget	Elementi di origine e di destinazione
DeploymentStepType	Tipo di passaggio di distribuzione
PipelineNewWorkspaceRequest	Dettagli di configurazione per la creazione di una nuova area di lavoro. Obbligatorio quando si esegue la distribuzione in una fase senza aree di lavoro assegnate.
PipelineOperation	Operazione della pipeline di distribuzione di Power BI
PipelineOperationNote	Nota che descrive la distribuzione.
PipelineOperationStatus	Stato dell'operazione della pipeline
PipelineOperationType	Tipo di operazione
PipelineOperationUser	Utente o entità servizio che ha eseguito l'operazione della pipeline.
PipelineUpdateAppSettings	Aggiornare l'app dell'organizzazione dopo la distribuzione
PreDeploymentDiffInformation	Quantità di elementi nuovi, diversi e identici distribuiti prima della distribuzione.
PrincipalType	Tipo di entità
SelectiveDeployRequest	Richiesta di distribuzione selettiva degli elementi da una fase della pipeline di distribuzione

DeployArtifactRequest

Richiesta di distribuzione di un elemento di Power BI , ad esempio un report o un dashboard

Nome	Tipo	Descrizione
options	DeploymentOptions	Opzioni di configurazione della distribuzione per un elemento di Power BI specifico (ad esempio un report o un dashboard)
sourceId	string	ID dell'elemento di Power BI (ad esempio un report o un dashboard) da distribuire

DeploymentError

Dettagli dell'errore per il passaggio di distribuzione

Nome	Tipo	Descrizione
errorCode	string	Il codice di errore
errorDetails	string	Dettagli aggiuntivi sull'errore

DeploymentExecutionPlan

Un piano di esecuzione della distribuzione

Nome	Tipo	Descrizione
steps	DeploymentExecutionStep[]	Raccolta dei passaggi del piano di esecuzione

DeploymentExecutionStep

Passaggio di esecuzione della distribuzione

Nome	Tipo	Descrizione
error	DeploymentError	Dettagli dell'errore. Applicabile solo se l'operazione della pipeline non è riuscita.
index	integer	Indice dei passaggi
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione.
sourceAndTarget	DeploymentSourceAndTarget	Elementi di origine e di destinazione del passaggio
status	PipelineOperationStatus	Stato dell'operazione della pipeline
type	DeploymentStepType	Tipo di passaggio di distribuzione

DeploymentExecutionStepPreDeploymentDiffState

Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione.

Nome	Tipo	Descrizione
Different	string	Prima della distribuzione, l'elemento nella fase di origine non era identico a quello nella fase di destinazione.
New	string	Nuovo elemento distribuito che non esiste nella fase di destinazione.
NoDifference	string	Prima della distribuzione, l'elemento nella fase di origine era identico a quello nella fase di destinazione.

DeploymentOptions

Opzioni di configurazione della distribuzione. Può essere specificato per l'intera distribuzione o per un elemento di Power BI specifico, ad esempio un report o un dashboard. Se vengono specificati entrambi, vengono usate solo le opzioni di distribuzione per l'elemento di Power BI.

Nome	Tipo	Descrizione
allowCreateArtifact	boolean	Se è consentito creare un nuovo elemento di Power BI, ad esempio un report o un dashboard, nell'area di lavoro della fase di destinazione. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.
allowOverwriteArtifact	boolean	Indica se è consentita la sovrascrittura di un elemento di Power BI , ad esempio un report o un dashboard, nell'area di lavoro della fase di destinazione. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.
allowOverwriteTargetArtifactLabel	boolean	Se è possibile modificare l'etichetta di un elemento di Power BI di destinazione, ad esempio un report o un dashboard. L'etichetta viene modificata quando l'origine è protetta, ma la destinazione non è. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.
allowPurgeData	boolean	Indica se eliminare tutti i dati dall'elemento di Power BI di destinazione ,ad esempio un report o un dashboard, quando si verifica una mancata corrispondenza dello schema. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.
allowSkipTilesWithMissingPrerequisites	boolean	Se ignorare i riquadri che non hanno un modello o un report nell'area di lavoro della fase di destinazione. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.
allowTakeOver	boolean	Indica se consentire l'override del proprietario del report impaginato precedente e diventare il proprietario del report impaginato. Applicabile quando si distribuisce un report impaginato in una fase che contiene già una copia del report impaginato di proprietà dell'utente. Se questa opzione non è impostata su `true` quando è necessaria per la distribuzione, la distribuzione avrà esito negativo.

DeploymentSourceAndTarget

Elementi di origine e di destinazione

Nome	Tipo	Descrizione
source	string	ID dell'elemento di Power BI distribuito dalla fase di origine
sourceDisplayName	string	Nome visualizzato dell'elemento di Power BI distribuito dalla fase di origine
target	string	ID dell'elemento di Power BI che verrà sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI.
targetDisplayName	string	Nome dell'elemento di Power BI che verrà sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI.
type	string	Tipo dell'elemento di Power BI che verrà sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI.

DeploymentStepType

Tipo di passaggio di distribuzione

Nome	Tipo	Descrizione
DashboardDeployment	string	Passaggio per la distribuzione di un singolo dashboard
DataflowDeployment	string	Passaggio per la distribuzione di un singolo flusso di dati
DatamartDeployment	string	Passaggio per la distribuzione di un singolo datamart
DatasetDeployment	string	Passaggio per la distribuzione di un singolo set di dati
ReportDeployment	string	Passaggio per la distribuzione di un singolo report

PipelineNewWorkspaceRequest

Dettagli di configurazione per la creazione di una nuova area di lavoro. Obbligatorio quando si esegue la distribuzione in una fase senza aree di lavoro assegnate.

Nome	Tipo	Descrizione
capacityId	string	ID della capacità a cui verrà assegnata la nuova area di lavoro. Se non specificato e il chiamante API dispone delle autorizzazioni per la capacità dell'area di lavoro della fase di origine, tale capacità verrà usata. In caso contrario, Power BI selezionerà una capacità per cui il chiamante DELL'API dispone delle autorizzazioni.
name	string	Nome della nuova area di lavoro

PipelineOperation

Operazione della pipeline di distribuzione di Power BI

Nome	Tipo	Descrizione
executionEndTime	string	Data e ora di fine dell'operazione
executionPlan	DeploymentExecutionPlan	Piano di esecuzione della distribuzione. Applicabile solo a una singola operazione della pipeline.
executionStartTime	string	Data e ora di inizio dell'operazione
id	string	ID operazione
lastUpdatedTime	string	Data e ora dell'ultimo aggiornamento dell'operazione
note	PipelineOperationNote	Nota che rappresenta una descrizione dell'operazione.
performedBy	PipelineOperationUser	Utente o entità servizio che ha eseguito l'operazione della pipeline.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Quantità di elementi distribuiti nella fase di origine, nuovi, identici o diversi agli elementi nella fase di destinazione, prima della distribuzione.
sourceStageOrder	integer	Identificatore numerico di una fase di distribuzione della pipeline di origine. Sviluppo (0), Test (1), Produzione (2).
status	PipelineOperationStatus	Stato dell'operazione della pipeline
targetStageOrder	integer	Identificatore numerico di una fase di distribuzione della pipeline di destinazione. Sviluppo (0), Test (1), Produzione (2).
type	PipelineOperationType	Tipo di operazione

PipelineOperationNote

Nota che descrive la distribuzione.

Nome	Tipo	Descrizione
content	string	Testo che descrive la distribuzione.
isTruncated	boolean	Indica se la nota è incompleta. True, viene restituita solo parte della nota. False, la nota è completa.

PipelineOperationStatus

Stato dell'operazione della pipeline

Nome	Tipo	Descrizione
Executing	string	Esecuzione dell'operazione
Failed	string	Operazione non riuscita
NotStarted	string	Operazione non avviata
Succeeded	string	Operazione riuscita

PipelineOperationType

Tipo di operazione

Nome	Tipo	Descrizione
Deploy	string	Distribuire il contenuto tra le fasi

PipelineOperationUser

Utente o entità servizio che ha eseguito l'operazione della pipeline.

Nome	Tipo	Descrizione
principalObjectID	string	ID dell'entità servizio che ha eseguito la distribuzione.
principalType	PrincipalType	Tipo di utente che ha eseguito la distribuzione.
userPrincipalName	string	UPN dell'utente che ha eseguito la distribuzione.

PipelineUpdateAppSettings

Aggiornare l'app dell'organizzazione dopo la distribuzione

Nome	Tipo	Descrizione
updateAppInTargetWorkspace	boolean	Indica se aggiornare l'app nell'area di lavoro di destinazione. Vengono aggiornati solo gli elementi distribuiti già presenti nell'app. I nuovi elementi distribuiti non vengono aggiunti all'app.

PreDeploymentDiffInformation

Quantità di elementi nuovi, diversi e identici distribuiti prima della distribuzione.

Nome	Tipo	Descrizione
differentArtifactsCount	integer	Numero di elementi distribuiti con differenze tra le fasi di origine e di destinazione, prima della distribuzione.
newArtifactsCount	integer	Numero di nuovi elementi distribuiti nella fase di destinazione.
noDifferenceArtifactsCount	integer	Numero di elementi distribuiti identici nelle fasi di origine e di destinazione, prima della distribuzione.

PrincipalType

Tipo di entità

Nome	Tipo	Descrizione
App	string	Tipo di entità servizio
Group	string	Tipo di entità gruppo
None	string	Nessun tipo di entità. Usare per l'accesso a livello di intera organizzazione.
User	string	Tipo di entità utente

SelectiveDeployRequest

Richiesta di distribuzione selettiva degli elementi da una fase della pipeline di distribuzione

Nome	Tipo	Descrizione
dashboards	DeployArtifactRequest[]	Elenco di dashboard da distribuire
dataflows	DeployArtifactRequest[]	Elenco di flussi di dati da distribuire
datamarts	DeployArtifactRequest[]	Elenco di datamarts da distribuire
datasets	DeployArtifactRequest[]	Elenco di set di dati da distribuire
isBackwardDeployment	boolean	Indica se la distribuzione verrà eseguita da una fase successiva nella pipeline di distribuzione, a una versione precedente. Il valore predefinito è `false`.
newWorkspace	PipelineNewWorkspaceRequest	Dettagli di configurazione per la creazione di una nuova area di lavoro. Obbligatorio quando si esegue la distribuzione in una fase senza aree di lavoro assegnate. La distribuzione avrà esito negativo se i dettagli di configurazione della nuova area di lavoro non vengono forniti quando necessario.
note	string	Nota che descrive la distribuzione.
options	DeploymentOptions	Opzioni che controllano il comportamento dell'intera distribuzione
reports	DeployArtifactRequest[]	Elenco di report da distribuire
sourceStageOrder	integer	Identificatore numerico della fase di distribuzione della pipeline da cui distribuire il contenuto. Sviluppo (0), Test (1), Produzione (2).
updateAppSettings	PipelineUpdateAppSettings	Aggiornare l'app dell'organizzazione nelle impostazioni dell'area di lavoro di destinazione

Condividi tramite

Pipelines - Selective Deploy

Autorizzazioni

Ambito obbligatorio

Limitazioni

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

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

Definizioni

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Risorse aggiuntive