Pipelines - Selective Deploy

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

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

Ten interfejs API obsługuje wdrażanie tylko elementów Power BI. Nie obsługuje on wdrażania innych typów elementów Fabric, takich jak lakehouses, warehouses, notebooks lub Dataflow Gen2.

Permissions

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

Wymagany zakres

Pipeline.Deploy

Limitations

Maksymalnie 300 wdrożonych elementów na żądanie.

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
pipelineId	path	True	string (uuid)	Identyfikator potoku wdrażania

Treść żądania

Nazwisko	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, które mają zostać wdrożone
datasets		DeployArtifactRequest[]	Lista zestawów danych do wdrożenia
isBackwardDeployment		boolean	Czy wdrożenie będzie z późniejszego etapu w 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 szczegóły konfiguracji nowego 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

Nazwisko	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

Przykładowe żądanie

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

Treść żądania

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Treść żądania

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

Przykładowa odpowiedź

Kod stanu:: 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

Nazwisko	Opis
DeployArtifactRequest	Żądanie wdrożenia elementu Power BI (na przykład raportu lub pulpitu nawigacyjnego)
DeploymentError	Szczegóły błędu dla kroku wdrażania
DeploymentExecutionPlan	Plan wykonywania 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 (takiego jak raport lub pulpit nawigacyjny). Jeśli zostaną określone oba te elementy, zostaną użyte tylko opcje wdrażania elementu usługi Power BI.
DeploymentSourceAndTarget	Elementy źródłowe i docelowe
DeploymentStepType	Typ kroku wdrażania
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 zaktualizuj aplikację 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

Objekt

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

Nazwisko	Typ	Opis
options	DeploymentOptions	Opcje konfiguracji wdrożenia dla określonego elementu Power BI (na przykład raportu lub pulpitu nawigacyjnego)
sourceId	string (uuid)	Identyfikator elementu Power BI (na przykład raport lub pulpit nawigacyjny) do wdrożenia

DeploymentError

Objekt

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

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

DeploymentExecutionPlan

Objekt

Plan wykonywania wdrożenia

Nazwisko	Typ	Opis
steps	DeploymentExecutionStep[]	Zbieranie kroków planu wykonania

DeploymentExecutionStep

Objekt

Krok wykonywania wdrożenia

Nazwisko	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 wdrażania

DeploymentExecutionStepPreDeploymentDiffState

Wyliczenie

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

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

DeploymentOptions

Objekt

Opcje konfiguracji wdrożenia. Można określić dla całego wdrożenia lub dla określonego elementu usługi Power BI (takiego jak raport lub pulpit nawigacyjny). Jeśli zostaną określone oba te elementy, zostaną użyte tylko opcje wdrażania elementu usługi Power BI.

Nazwisko	Typ	Opis
allowCreateArtifact	boolean	Czy tworzenie nowego elementu usługi Power BI (takiego jak raport lub pulpit nawigacyjny) w obszarze roboczym etapu docelowego jest dozwolone. Jeśli ta opcja nie jest ustawiona na `true`, gdy jest wymagana do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowOverwriteArtifact	boolean	Niezależnie od tego, czy zastępowanie elementu usługi Power BI (takiego jak raport lub pulpit nawigacyjny) w obszarze roboczym etapu docelowego jest dozwolone. Jeśli ta opcja nie jest ustawiona na `true`, gdy jest wymagana 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`, gdy jest wymagana 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`, gdy jest wymagana 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`, gdy jest wymagana do wdrożenia, wdrożenie zakończy się niepowodzeniem.
allowTakeOver	boolean	Czy zezwolić na zastępowanie 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`, gdy jest wymagana do wdrożenia, wdrożenie zakończy się niepowodzeniem.

DeploymentSourceAndTarget

Objekt

Elementy źródłowe i docelowe

Nazwisko	Typ	Opis
source	string (uuid)	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 (uuid)	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

Wyliczenie

Typ kroku wdrażania

Wartość	Opis
DatasetDeployment	Krok wdrażania pojedynczego zestawu danych
ReportDeployment	Krok wdrażania pojedynczego raportu
DashboardDeployment	Krok wdrażania pojedynczego pulpitu nawigacyjnego
DataflowDeployment	Krok wdrażania pojedynczego przepływu danych
DatamartDeployment	Krok wdrażania pojedynczego elementu datamart

PipelineNewWorkspaceRequest

Objekt

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

Nazwisko	Typ	Opis
capacityId	string (uuid)	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, zostanie użyta ta pojemność. 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

Objekt

Operacja potoku wdrażania usługi Power BI

Nazwisko	Typ	Opis
executionEndTime	string (date-time)	Data i godzina zakończenia operacji
executionPlan	DeploymentExecutionPlan	Plan wykonania wdrożenia. Dotyczy tylko jednej operacji potoku.
executionStartTime	string (date-time)	Data i godzina rozpoczęcia operacji
id	string (uuid)	Identyfikator operacji
lastUpdatedTime	string (date-time)	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 docelowego etapu wdrażania potoku. Programowanie (0), testowanie (1), produkcja (2).
type	PipelineOperationType	Typ operacji

PipelineOperationNote

Objekt

Notatka opisująca wdrożenie.

Nazwisko	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

Wyliczenie

Stan operacji potoku

Wartość	Opis
NotStarted	Operacja nie została uruchomiona
Executing	Wykonywanie operacji
Succeeded	Operacja powiodła się
Failed	Operacja nie powiodła się

PipelineOperationType

Wyliczenie

Typ operacji

Wartość	Opis
Deploy	Wdrażanie zawartości między etapami

PipelineOperationUser

Objekt

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

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

PipelineUpdateAppSettings

Objekt

Konfiguracja zaktualizuj aplikację organizacji po wdrożeniu

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

PreDeploymentDiffInformation

Objekt

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

Nazwisko	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

Wyliczenie

Typ podmiotu zabezpieczeń

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

SelectiveDeployRequest

Objekt

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

Nazwisko	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, które mają zostać wdrożone
datasets	DeployArtifactRequest[]	Lista zestawów danych do wdrożenia
isBackwardDeployment	boolean	Czy wdrożenie będzie z późniejszego etapu w 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 szczegóły konfiguracji nowego 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