Automatisieren Sie Deployments mit einem Bereitstellungsplan (Vorschau)

Ein Bereitstellungsplan verlängert eine bestehende API-Anfrage. Es ersetzt nicht den Standardablauf der API. Fügen Sie einen Plan hinzu, um die Reihenfolge der Artikel festzulegen. Ein Plan kann auch Aktionen vor oder nach dem Einsatz eines Gegenstands ausführen. Die ursprüngliche Anfrage legt weiterhin Quelle, Ziel und ausgewählte Elemente fest.

Important

Dieses Feature befindet sich in der Vorschauphase.

Wählen Sie einen Automatisierungsworkflow

Beginnen Sie mit dem Automatisierungsleitfaden für Ihren Betrieb. Fügen Sie dann die Eingabe des Einsatzplans aus diesem Artikel hinzu.

API, die einen Bereitstellungsplan akzeptiert Bestehende Automatisierungsrichtlinien
Update von Git Automatisieren der Git-Integration mithilfe von APIs
Stage-Inhalte deployen Automatisieren Sie Ihre Bereitstellungspipeline mit Fabric-APIs
Definitionen von Massenimportartikeln Fabric CI/CD mit API für den Massenimport von Elementdefinitionen

Ohne einen Deployment-Plan funktioniert jede API wie zuvor.

Das sind die APIs, die die Eingabe deploymentPlan aufnehmen. Ihr Workflow kann auch andere APIs aufrufen, um die Operation vorzubereiten oder den Status zu überprüfen. Verwenden Sie weiterhin die unterstützenden APIs, wie sie im bestehenden Automatisierungsleitfaden beschrieben sind.

Voraussetzungen

Bevor Sie einen Plan hinzufügen:

  • Erstellen Sie den Einsatzplan. Stellen Sie sicher, dass die Operation das Problem lösen kann.
  • Erhalten Sie ein Microsoft Entra-Zugangstoken. Nutze es für die Fabric API.
  • Stellen Sie sicher, dass der Anrufer die für die ursprüngliche Operation erforderlichen Rollen erfüllt.
  • Stellen Sie sicher, dass das Token den Gültigkeitsbereich des ursprünglichen Vorgangs und Item.Execute.All enthält.
  • Fügen Sie beta=true zur Operations-URL hinzu.

Das Token muss folgende Berechtigungsbereiche enthalten:

Operation Ursprünglicher Betriebsumfang Zusätzlicher Spielraum, wenn ein Plan bereitgestellt wird
Aus Git aktualisieren Workspace.GitUpdate.All Item.Execute.All
Bereitstellen von Phaseninhalten Pipeline.Deploy oder DeploymentPipeline.Deploy.All Item.Execute.All
Definitionen von Massenimportartikeln Item.ReadWrite.All Item.Execute.All

Der Aufrufer benötigt außerdem die in der ursprünglichen API-Referenz aufgeführten Rollen. Die gleiche Referenz listet die Identitätstypen auf, die die API unterstützt. Ein Service Principal oder eine verwaltete Identität funktioniert nur, wenn jedes Element in der Operation sie unterstützt.

Fügen Sie den Bereitstellungsplan zu einer Anfrage hinzu

Für jede unterstützte API:

  1. beta=true zur Anfrage-URL hinzufügen.
  2. Füge ein deploymentPlan Objekt innerhalb des bestehenden options Objekts hinzu.
  3. Lass den Rest der Anfrage unverändert.

Verwenden Sie die Kleinbuchstaben-Eigenschaft referenceType . Bei dem Wert wird die Groß-/Kleinschreibung beachtet.

Aktualisieren Sie einen Arbeitsbereich aus Git

Verwenden Sie die logische ID des Plans. Der Plan kann aus dem Arbeitsbereich oder aus dem eingehenden Git-Inhalt stammen. Für einen Plan, der in Git gespeichert ist, suche die logische ID in deren .platform Datei.

Für eine API-gesteuerte Anfangssynchronisierung rufen Sie zuerst Initialize Connection auf. Wenn die Antwort ein Update erfordert, fügen Sie den Plan der folgenden Update From Git-Anfrage hinzu. Initialize Connection akzeptiert keinen Deployment-Plan.

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

Fügen Sie das folgende Objekt zur Update From Git-Anfrage hinzu:

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

Behalten Sie workspaceHead, remoteCommitHash, die Konfliktlösung und die anderen Optionen bei. Erstelle die vollständige Anfrage mit dem Git-Automatisierungsguide. Der Leitfaden zeigt außerdem, wie man den Betriebsstatus abfragt. Siehe Update von Git.

Inhalt zwischen den Pipeline-Stufen bereitstellen

Beziehen Sie sich auf den Einsatzplan anhand seiner Item-ID.

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

Füge das folgende Objekt zur Deploy Stage Content Anfrage hinzu:

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

Behalten Sie die Quellstufe, die Zielstufe, die ausgewählten Elemente, den Bereitstellungshinweis und weitere Optionen bei. Erstellen Sie die vollständige Anfrage mithilfe des Leitfadens für die Bereitstellungspipeline. Der Leitfaden zeigt außerdem, wie man den Betriebsstatus abfragt. Siehe Automatisierung Ihrer Bereitstellungspipeline mit Fabric-APIs.

Elementdefinitionen importieren

Verwenden Sie die logische ID des Plans. Sie finden sie in der .platform-Datei des Plans.

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

Fügen Sie den Bereitstellungsplan zu den Optionen für Massenimport-Anfragen hinzu:

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

Behalte alle Element-Definitionsteile und Importoptionen. Erstellen Sie die vollständige Anfrage mit dem Bulk-Import-Tutorial. Das Tutorial zeigt auch, wie man den Operationsstatus abfragt. Siehe Fabric CI/CD mit der Bulk Import Item Definitions API.

Verstehen Sie, was der Plan ändert

Der Plan ändert nur die Reihenfolge und die Maßnahmen. Die ausgewählten Gegenstände werden nicht geändert.

Eingaben anfordern Was sie steuert
Ursprüngliche API-Anfrage Quelle, Ziel, ausgewählte Gegenstände und betriebsspezifische Einstellungen
Bereitstellungsplan Explizite Elementreihenfolge und Aktionen vor oder nach der Bereitstellung
Fabric-Datenherkunft Abhängigkeiten, die Fabric zwischen ausgewählten Gegenständen erkennt

Ausgewählte Elemente außerhalb einer Einsatzgruppe verwenden das Standardverhalten der Operation.

Wie der Umfang der Anfragen, Planbeziehungen, Fabric-Linie und Aktionen zusammenwirken, siehe Wie ein Einsatzplan funktioniert.

Anfrage validieren

Bevor Sie die Automatisierung ausführen, überprüfen Sie, dass:

  • Die URL enthält beta=true.
  • Das Token enthält Item.Execute.All und den Gültigkeitsbereich des ursprünglichen Vorgangs.
  • Das Objekt deploymentPlan befindet sich in options, nicht am Request-Root.
  • referenceType verwendet den dokumentierten Wert und das Gehäuse.
  • Die Artikel-ID oder logische ID ist nicht leer oder fehlgeformt.
  • Die Operation kann den Plan im relevanten Arbeitsbereich oder im eingehenden Inhalt auflösen.
  • Die Plandefinition ist gültig und enthält keine zirkuläre Abhängigkeit.

Die Operation stoppt, wenn die Validierung, ein Element oder eine Aktion fehlschlägt. Fabric macht bereits abgeschlossene Arbeit nicht rückgängig.

Überlegungen und Einschränkungen

Die Bibliothek fabric-cicd unterstützt keine Bereitstellungspläne. Verwenden Sie Update from Git, deployen Sie Stage-Inhalte oder importieren Sie Item-Definitionen in großen Mengen, wenn Sie eine Bereitstellung mit einem Plan automatisieren.

Für alle Einschränkungen des Einsatzplans siehe Überlegungen und Einschränkungen des Einsatzplans.

Verwaltung des Einsatzplan-Punkts

Ein Bereitstellungsplan ist ein Fabric-Element. Verwenden Sie die folgenden Fabric REST APIs, um sie zu verwalten. Diese Anrufe sind von der Bereitstellungsoperation getrennt.

Aufgabe REST API
Einen Plan erstellen Erstellen Sie Bereitstellungsplan
Pläne in einem Arbeitsbereich auflisten Listenelemente
Planeigenschaften abrufen Item holen
Erhalten Sie die Plandefinition Erhalte die Definition des Gegenstands
Eigenschaften des Plans aktualisieren Element aktualisieren
Aktualisierung der Plandefinition Aktualisierung der Artikeldefinition
Löschen eines Plans Element löschen

Die Definition des Einsatzplans enthält Teile mit Pfad, Base64-Nutzlast und InlineBase64 Nutzlasttyp.