Pipelines - Selective Deploy

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Wdraża określone elementy z etapu źródłowego określonego potoku wdrażania.

Uprawnienia

Użytkownik musi być co najmniej członkiem w obszarach roboczych wdrożenia źródłowego i docelowego. Aby uzyskać więcej informacji, zobacz Uprawnienia.

Wymagany zakres

Pipeline.Deploy

Ograniczenia

Maksymalna liczba wdrożonych elementów na żądanie wynosi 300.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
pipelineId	path	True	string uuid	Identyfikator potoku wdrażania

Treść żądania

Nazwa	Wymagane	Typ	Opis
sourceStageOrder	True	integer	Identyfikator liczbowy etapu wdrażania potoku, z którego powinna zostać wdrożona zawartość. Programowanie (0), Testowanie (1), Produkcja (2).
dashboards		DeployArtifactRequest[]	Lista pulpitów nawigacyjnych do wdrożenia
dataflows		DeployArtifactRequest[]	Lista przepływów danych do wdrożenia
datamarts		DeployArtifactRequest[]	Lista magazynów danych do wdrożenia
datasets		DeployArtifactRequest[]	Lista zestawów danych do wdrożenia
isBackwardDeployment		boolean	Czy wdrożenie będzie z późniejszego etapu potoku wdrażania, do wcześniejszego. Wartość domyślna to `false`.
newWorkspace		PipelineNewWorkspaceRequest	Szczegóły konfiguracji dotyczące tworzenia nowego obszaru roboczego. Wymagane podczas wdrażania na etapie, który nie ma przypisanych obszarów roboczych. Wdrożenie zakończy się niepowodzeniem, jeśli nowe szczegóły konfiguracji obszaru roboczego nie zostaną podane w razie potrzeby.
note		string	Notatka opisująca wdrożenie.
options		DeploymentOptions	Opcje kontrolujące zachowanie całego wdrożenia
reports		DeployArtifactRequest[]	Lista raportów do wdrożenia
updateAppSettings		PipelineUpdateAppSettings	Aktualizowanie aplikacji organizacji w ustawieniach docelowego obszaru roboczego

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	PipelineOperation	Zaakceptowano

Przykłady

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

Definicje

Nazwa	Opis
DeployArtifactRequest	Żądanie wdrożenia elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
DeploymentError	Szczegóły błędu dla kroku wdrażania
DeploymentExecutionPlan	Plan wykonania wdrożenia
DeploymentExecutionStep	Krok wykonywania wdrożenia
DeploymentExecutionStepPreDeploymentDiffState	Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.
DeploymentOptions	Opcje konfiguracji wdrożenia. Można określić dla całego wdrożenia lub dla określonego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego). W przypadku określenia obu opcji wdrażania są używane tylko opcje wdrażania elementu usługi Power BI.
DeploymentSourceAndTarget	Elementy źródłowe i docelowe
DeploymentStepType	Typ kroku wdrożenia
PipelineNewWorkspaceRequest	Szczegóły konfiguracji dotyczące tworzenia nowego obszaru roboczego. Wymagane podczas wdrażania na etapie, który nie ma przypisanych obszarów roboczych.
PipelineOperation	Operacja potoku wdrażania usługi Power BI
PipelineOperationNote	Notatka opisująca wdrożenie.
PipelineOperationStatus	Stan operacji potoku
PipelineOperationType	Typ operacji
PipelineOperationUser	Użytkownik lub jednostka usługi, która wykonała operację potoku.
PipelineUpdateAppSettings	Konfiguracja aktualizacji aplikacji organizacji po wdrożeniu
PreDeploymentDiffInformation	Ilość nowych, różnych i identycznych wdrożonych elementów przed wdrożeniem.
PrincipalType	Typ podmiotu zabezpieczeń
SelectiveDeployRequest	Żądanie selektywnego wdrażania elementów z etapu potoku wdrażania

DeployArtifactRequest

Żądanie wdrożenia elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)

Nazwa	Typ	Opis
options	DeploymentOptions	Opcje konfiguracji wdrożenia dla określonego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
sourceId	string	Identyfikator elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) do wdrożenia

DeploymentError

Szczegóły błędu dla kroku wdrażania

Nazwa	Typ	Opis
errorCode	string	Kod błędu
errorDetails	string	Dodatkowe szczegóły błędu

DeploymentExecutionPlan

Plan wykonania wdrożenia

Nazwa	Typ	Opis
steps	DeploymentExecutionStep[]	Kolekcja kroków planu wykonania

DeploymentExecutionStep

Krok wykonywania wdrożenia

Nazwa	Typ	Opis
error	DeploymentError	Szczegóły błędu. Dotyczy tylko wtedy, gdy operacja potoku nie powiodła się.
index	integer	Indeks kroku
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.
sourceAndTarget	DeploymentSourceAndTarget	Elementy źródłowe i docelowe kroku
status	PipelineOperationStatus	Stan operacji potoku
type	DeploymentStepType	Typ kroku wdrożenia

DeploymentExecutionStepPreDeploymentDiffState

Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.

Nazwa	Typ	Opis
Different	string	Przed wdrożeniem element na etapie źródłowym nie był identyczny z elementem na etapie docelowym.
New	string	Nowy wdrożony element, który nie istnieje na etapie docelowym.
NoDifference	string	Przed wdrożeniem element na etapie źródłowym był identyczny z elementem na etapie docelowym.

DeploymentOptions

Opcje konfiguracji wdrożenia. Można określić dla całego wdrożenia lub dla określonego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego). W przypadku określenia obu opcji wdrażania są używane tylko opcje wdrażania elementu usługi Power BI.

Nazwa	Typ	Opis
allowCreateArtifact	boolean	Niezależnie od tego, czy tworzenie nowego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) w obszarze roboczym etapu docelowego jest dozwolone. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowOverwriteArtifact	boolean	Niezależnie od tego, czy zastępowanie elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego) w obszarze roboczym etapu docelowego jest dozwolone. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowOverwriteTargetArtifactLabel	boolean	Niezależnie od tego, czy można zmienić etykietę docelowego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego). Etykieta zostanie zmieniona, gdy źródło jest chronione, ale obiekt docelowy nie jest. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowPurgeData	boolean	Czy usunąć wszystkie dane z docelowego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego), gdy występuje niezgodność schematu. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowSkipTilesWithMissingPrerequisites	boolean	Czy pominąć kafelki, które nie mają modelu, czy raportu w obszarze roboczym etapu docelowego. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowTakeOver	boolean	Czy zezwolić na zastąpienie poprzedniego właściciela raportu podzielonego na strony i staje się właścicielem raportu podzielonego na strony. Dotyczy wdrażania raportu podzielonego na strony na etapie, który zawiera już kopię raportu podzielonego na strony, który nie jest własnością Użytkownika. Jeśli ta opcja nie jest ustawiona na `true` wymaganą do wdrożenia, wdrożenie zakończy się niepowodzeniem.

DeploymentSourceAndTarget

Elementy źródłowe i docelowe

Nazwa	Typ	Opis
source	string	Identyfikator elementu usługi Power BI wdrożonego na etapie źródłowym
sourceDisplayName	string	Nazwa wyświetlana elementu usługi Power BI wdrożonego na etapie źródłowym
target	string	Identyfikator elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.
targetDisplayName	string	Nazwa elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.
type	string	Typ elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.

DeploymentStepType

Typ kroku wdrożenia

Nazwa	Typ	Opis
DashboardDeployment	string	Krok wdrażania pojedynczego pulpitu nawigacyjnego
DataflowDeployment	string	Krok wdrażania pojedynczego przepływu danych
DatamartDeployment	string	Krok wdrażania pojedynczego elementu datamart
DatasetDeployment	string	Krok wdrażania pojedynczego zestawu danych
ReportDeployment	string	Krok wdrażania pojedynczego raportu

PipelineNewWorkspaceRequest

Szczegóły konfiguracji dotyczące tworzenia nowego obszaru roboczego. Wymagane podczas wdrażania na etapie, który nie ma przypisanych obszarów roboczych.

Nazwa	Typ	Opis
capacityId	string	Identyfikator pojemności, do której zostanie przypisany nowy obszar roboczy. Jeśli obiekt wywołujący interfejs API ma uprawnienia do pojemności obszaru roboczego etapu źródłowego, ta pojemność zostanie użyta. W przeciwnym razie usługa Power BI wybierze pojemność, dla którego obiekt wywołujący interfejs API ma uprawnienia.
name	string	Nazwa nowego obszaru roboczego

PipelineOperation

Operacja potoku wdrażania usługi Power BI

Nazwa	Typ	Opis
executionEndTime	string	Data i godzina zakończenia operacji
executionPlan	DeploymentExecutionPlan	Plan wykonania wdrożenia. Dotyczy tylko jednej operacji potoku.
executionStartTime	string	Data i godzina rozpoczęcia operacji
id	string	Identyfikator operacji
lastUpdatedTime	string	Data i godzina ostatniej aktualizacji operacji
note	PipelineOperationNote	Notatka reprezentująca opis operacji.
performedBy	PipelineOperationUser	Użytkownik lub jednostka usługi, która wykonała operację potoku.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Ilość wdrożonych elementów na etapie źródłowym, które są nowe, identyczne lub inne niż elementy na etapie docelowym, przed wdrożeniem.
sourceStageOrder	integer	Identyfikator liczbowy etapu wdrażania potoku źródłowego. Programowanie (0), Testowanie (1), Produkcja (2).
status	PipelineOperationStatus	Stan operacji potoku
targetStageOrder	integer	Identyfikator liczbowy etapu wdrażania potoku docelowego. Programowanie (0), Testowanie (1), Produkcja (2).
type	PipelineOperationType	Typ operacji

PipelineOperationNote

Notatka opisująca wdrożenie.

Nazwa	Typ	Opis
content	string	Tekst opisujący wdrożenie.
isTruncated	boolean	Wskazuje, czy notatka jest niekompletna. Prawda, zwracana jest tylko część notatki. Fałsz, notatka jest kompletna.

PipelineOperationStatus

Stan operacji potoku

Nazwa	Typ	Opis
Executing	string	Wykonywanie operacji
Failed	string	Operacja nie powiodła się
NotStarted	string	Operacja nie została uruchomiona
Succeeded	string	Operacja powiodła się

PipelineOperationType

Typ operacji

Nazwa	Typ	Opis
Deploy	string	Wdrażanie zawartości między etapami

PipelineOperationUser

Użytkownik lub jednostka usługi, która wykonała operację potoku.

Nazwa	Typ	Opis
principalObjectID	string	Identyfikator jednostki usługi, która wykonała wdrożenie.
principalType	PrincipalType	Typ użytkownika, który wykonał wdrożenie.
userPrincipalName	string	Nazwa UPN użytkownika, który wykonał wdrożenie.

PipelineUpdateAppSettings

Konfiguracja aktualizacji aplikacji organizacji po wdrożeniu

Nazwa	Typ	Opis
updateAppInTargetWorkspace	boolean	Czy zaktualizować aplikację w docelowym obszarze roboczym. Zaktualizowane są tylko wdrożone elementy, które już istnieją w aplikacji. Nowe wdrożone elementy nie są dodawane do aplikacji.

PreDeploymentDiffInformation

Ilość nowych, różnych i identycznych wdrożonych elementów przed wdrożeniem.

Nazwa	Typ	Opis
differentArtifactsCount	integer	Liczba wdrożonych elementów z różnicami między etapami źródłowymi i docelowymi przed wdrożeniem.
newArtifactsCount	integer	Liczba nowych elementów wdrożonych na etapie docelowym.
noDifferenceArtifactsCount	integer	Liczba identycznych wdrożonych elementów na etapach źródłowych i docelowych przed wdrożeniem.

PrincipalType

Typ podmiotu zabezpieczeń

Nazwa	Typ	Opis
App	string	Typ jednostki usługi
Group	string	Typ podmiotu zabezpieczeń grupy
None	string	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	string	Typ podmiotu zabezpieczeń użytkownika

SelectiveDeployRequest

Żądanie selektywnego wdrażania elementów z etapu potoku wdrażania

Nazwa	Typ	Opis
dashboards	DeployArtifactRequest[]	Lista pulpitów nawigacyjnych do wdrożenia
dataflows	DeployArtifactRequest[]	Lista przepływów danych do wdrożenia
datamarts	DeployArtifactRequest[]	Lista magazynów danych do wdrożenia
datasets	DeployArtifactRequest[]	Lista zestawów danych do wdrożenia
isBackwardDeployment	boolean	Czy wdrożenie będzie z późniejszego etapu potoku wdrażania, do wcześniejszego. Wartość domyślna to `false`.
newWorkspace	PipelineNewWorkspaceRequest	Szczegóły konfiguracji dotyczące tworzenia nowego obszaru roboczego. Wymagane podczas wdrażania na etapie, który nie ma przypisanych obszarów roboczych. Wdrożenie zakończy się niepowodzeniem, jeśli nowe szczegóły konfiguracji obszaru roboczego nie zostaną podane w razie potrzeby.
note	string	Notatka opisująca wdrożenie.
options	DeploymentOptions	Opcje kontrolujące zachowanie całego wdrożenia
reports	DeployArtifactRequest[]	Lista raportów do wdrożenia
sourceStageOrder	integer	Identyfikator liczbowy etapu wdrażania potoku, z którego powinna zostać wdrożona zawartość. Programowanie (0), Testowanie (1), Produkcja (2).
updateAppSettings	PipelineUpdateAppSettings	Aktualizowanie aplikacji organizacji w ustawieniach docelowego obszaru roboczego

Udostępnij za pośrednictwem

Pipelines - Selective Deploy

Uprawnienia

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

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

Definicje

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Dodatkowe zasoby