Automatyzacja wdrożeń za pomocą planu wdrożenia (podgląd)

Plan wdrożenia rozszerza istniejące żądanie API. Nie zastępuje standardowego przepływu API. Dodaj plan ustalania kolejności przedmiotów. Plan może także wykonywać działania przed lub po rozmieszczeniu przedmiotu. Oryginalne żądanie nadal ustawia źródło, cel i wybrane elementy.

Ważna

Ta funkcja jest dostępna w wersji zapoznawczej.

Wybierz automatyzację

Zacznij od przewodnika po automatyzacji dla swojej działalności. Następnie dodaj informacje o planie wdrożenia z tego artykułu.

API akceptujące plan wdrożenia Istniejące wytyczne dotyczące automatyzacji
Aktualizacja z Gita Automatyzowanie integracji z usługą Git przy użyciu interfejsów API
Wdrażaj zawartość etapu wdrażania Zautomatyzuj swój pipeline wdrożeniowy za pomocą Fabric API
Definicje pozycji importu zbiorczego Fabric CI/CD przy użyciu interfejsu API do zbiorczego importowania definicji elementów

Bez planu wdrożenia każde API działa jak wcześniej.

To są API, które akceptują deploymentPlan dane wejściowe. Twój workflow może także wywoływać inne API, aby przygotować operację lub sprawdzić jej status. Kontynuuj korzystanie z wspierających API, jak opisano w istniejącym przewodniku automatyzacji.

Wymagania wstępne

Zanim dodasz plan:

  • Stwórz plan wdrożenia. Upewnij się, że operacja może to rozwiązać.
  • Kup token dostępu Microsoft Entra. Użyj go do Fabric API.
  • Upewnij się, że dzwoniący ma role wymagane przez oryginalną operację.
  • Upewnij się, że token zawiera zakres oryginalnej operacji oraz Item.Execute.All.
  • Dodaj beta=true do adresu URL operacji.

Token musi zawierać następujące zakresy:

Operation Pierwotny zakres działania Dodatkowy zakres możliwości po przedstawieniu planu
Aktualizuj z usługi Git Workspace.GitUpdate.All Item.Execute.All
Wdrożenie zawartości etapu Pipeline.Deploy lub DeploymentPipeline.Deploy.All Item.Execute.All
Import zbiorczy definicji elementów Item.ReadWrite.All Item.Execute.All

Podmiot wywołujący wymaga również ról wymienionych w oryginalnym dokumencie referencyjnym interfejsu API. To samo źródło zawiera listę typów tożsamości obsługiwanych przez interfejs API. Jednostka usługi lub tożsamość zarządzana działa tylko wtedy, gdy każdy element w ramach operacji je obsługuje.

Dodaj plan wdrożenia do zapytania

Dla każdego obsługiwanego API:

  1. Dodaj beta=true do adresu URL żądania.
  2. Dodaj deploymentPlan obiekt wewnątrz istniejącego options obiektu.
  3. Reszta prośby zostaw bez zmian.

Użyj właściwości referenceType zapisanej małymi literami. Jej wartość jest uwzględniana w wielkości liter.

Zaktualizuj przestrzeń roboczą z Gita

Użyj logicznego identyfikatora planu. Plan może pochodzić z przestrzeni roboczej lub z przychodzącej zawartości Git. Dla planu przechowywanego w Gicie znajdź logiczny identyfikator w jego .platform pliku.

Aby uruchomić początkową synchronizację sterowaną przez API, najpierw wywołaj Initialize Connection . Jeśli odpowiedź wymaga aktualizacji, dodaj plan do następującego żądania Update From Git. Initialize Connection nie akceptuje planu wdrożenia.

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit?beta=true

Dodaj następujący obiekt do żądania Update From Git:

{
  "options": {
    "deploymentPlan": {
      "logicalId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByLogicalId"
    }
  }
}

Zachowaj workspaceHead, remoteCommitHash, rozwiązywanie konfliktów i inne opcje. Utwórz kompletne żądanie, korzystając z przewodnika po automatyzacji Git. Przewodnik pokazuje również, jak sprawdzić status operacji. Zobacz Aktualizację z Gita.

Wdróż zawartość między etapami potoku

Odwołuj się do planu wdrożenia za pomocą identyfikatora elementu.

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/deploy?beta=true

Dodaj następujący obiekt do żądania wdrożenia zawartości etapu:

{
  "options": {
    "deploymentPlan": {
      "itemId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByItemId"
    }
  }
}

Zachowaj etap źródłowy, docelowy etap, wybrane przedmioty, notatkę wdrożenia i inne opcje. Zbuduj pełne żądanie, korzystając z przewodnika pipeline wdrożeniowego. Przewodnik pokazuje również, jak sprawdzić status operacji. Zobacz Jak zautomatyzować potok wdrażania za pomocą interfejsów API platformy Fabric.

Import definicji elementów

Użyj logicznego identyfikatora planu. Znajdź go w .platform pliku planu.

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/bulkImportDefinitions?beta=true

Dodaj plan wdrożenia do opcji żądania importu zbiorczego.

{
  "options": {
    "allowPairingByName": false,
    "deploymentPlan": {
      "logicalId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByLogicalId"
    }
  }
}

Zachowaj wszystkie elementy definicji przedmiotów i opcje importu. Zbuduj pełne żądanie, korzystając z tutoriala Bulk Import. Samouczek pokazuje też, jak sprawdzić status operacji. Zobacz Fabric CI/CD przy użyciu interfejsu API Bulk Import Item Definitions.

Zrozum, co plan zmienia

Plan zmienia jedynie kolejność i działania. Nie zmienia wybranych przedmiotów.

Żądanie danych wejściowych Co kontroluje
Oryginalne żądanie API Źródło, cel, wybrane elementy oraz ustawienia specyficzne dla działania
Plan wdrożenia Wyraźna kolejność elementów oraz działania przed lub po wdrożeniu
Linia Fabric Zależności wykrywane przez Fabric pomiędzy wybranymi elementami

Wybrane elementy spoza grupy wdrożeniowej wykorzystują standardowe zachowanie operacji.

Aby dowiedzieć się, jak zakres żądań, relacje planów, linia Fabric oraz działania współpracują, zobacz: Jak działa plan wdrożenia.

Zweryfikowaj żądanie

Zanim uruchomisz automatyzację, sprawdź, że:

  • URL zawiera beta=true.
  • Token zawiera Item.Execute.All oraz zakres oryginalnej operacji.
  • Obiekt deploymentPlan znajduje się wewnątrz options, a nie przy korzeniu żądania.
  • referenceType wykorzystuje udokumentowaną wartość i obudowanie.
  • ID przedmiotu ani logiczny identyfikator nie jest pusty ani zdeformowany.
  • Operacja może określić plan w odpowiednim obszarze roboczym lub w treściach przychodzących.
  • Definicja planu jest ważna i nie zawiera zależności kołowej.

Operacja kończy się, gdy walidacja, element lub akcja zakończy się niepowodzeniem. Fabric nie cofa ukończonej pracy.

Uwagi i ograniczenia

Biblioteka fabric-cicd nie obsługuje planów wdrożenia. Użyj opcji Update From Git, Deploy Stage Content lub Bulk Import Item Definitions, gdy automatyzujesz wdrożenie za pomocą planu.

Wszystkie ograniczenia planu wdrożenia można znaleźć w artykule Rozważania i ograniczenia planu wdrożenia.

Zarządzaj elementem planu wdrożenia

Plan wdrożenia jest składnikiem Fabric. Do zarządzania tym korzystaj z następujących API Fabric REST. Te wywołania są odrębne od operacji wdrożenia.

Zadanie interfejs API REST
Tworzenie planu Stwórz Plan Rozmieszczenia
Umieść plany w przestrzeni roboczej Pozycje listy
Pobierz właściwości planu Pobierz przedmiot
Uzyskaj definicję planu Pobierz definicję przedmiotu
Zaktualizuj właściwości planu Aktualizuj element
Aktualizacja definicji planu Zaktualizuj definicję przedmiotu
Usuwanie planu Usuwanie elementu

Definicja planu wdrożenia zawiera części zawierające ścieżkę, ładunek zakodowany w formacie Base64 oraz typ ładunku InlineBase64.