Automatisieren Ihrer Bereitstellungspipeline mit Fabric APIs

Mit dem Microsoft Fabric-Bereitstellungspipelinentool können Teams einen effizienten und wiederverwendbaren Veröffentlichungsprozess für ihre Fabric-Inhalte erstellen.

Verwenden Sie die Bereitstellungspipelinen Fabric-REST-APIs , um Fabric in den Automatisierungsprozess Ihrer Organisation zu integrieren. Im Folgenden finden Sie einige Beispiele dafür, was mithilfe der API möglich ist:

• Integrieren Sie Fabric in vertraute DevOps-Tools wie Azure DevOps oder GitHub Actions.

• Planen Sie Pipelinebereitstellungen so, dass sie zu einem bestimmten Zeitpunkt automatisch erfolgen.

• Stellen Sie mehrere Pipelines gleichzeitig bereit.

• Kaskadieren abhängig von Pipelinebereitstellungen Wenn Sie über Inhalte verfügen, die pipelineübergreifend verbunden sind, können Sie sicherstellen, dass einige Pipelines vor anderen bereitgestellt werden.

Voraussetzungen

Um mit Bereitstellungspipeline-APIs zu arbeiten, benötigen Sie die folgenden Voraussetzungen:

• Die gleichen Voraussetzungen, die Sie für die Verwendung von Bereitstellungspipelines benötigen.
• Ein Microsoft Entra-Token zur Nutzung von Fabric. Verwenden Sie dieses Token im Autorisierungsheader des API-Aufrufs. Informationen zum Abrufen eines Tokens finden Sie in der Fabric-API-Schnellstartanleitung.

Sie können die REST-API ohne PowerShell verwenden; die Skripts in diesem Artikel nutzen aber PowerShell. Um die Skripts ausführen zu können, müssen Sie die folgenden Programme installieren:

• PowerShell
• Azure PowerShell Az-Modul

API-Funktionen für Bereitstellungspipelines

Die Bereitstellungspipelines Fabric-REST-APIs ermöglichen Ihnen, die folgenden Funktionen auszuführen:

• Bereitstellungspipeline abrufen: Gibt Informationen zur angegebenen Bereitstellungspipeline zurück.

• Bereitstellungspipelines auflisten: Gibt eine Liste von Bereitstellungspipelines zurück, auf die der Benutzer Zugriff hat.

• Phasen der Bereitstellungspipeline auflisten: Gibt die Phasen der angegebenen Bereitstellung zurück, einschließlich id, Anzeigename, Beschreibung und ob die Phase öffentlich ist oder nicht.

• Auflisten der Stageelemente der Bereitstellungspipeline: Gibt die unterstützten Elemente aus dem Arbeitsbereich zurück, welcher der angegebenen Stage der angegebenen Bereitstellungspipeline zugewiesen sind.

• Bereitstellen von Stageinhalten: Stellt Elemente aus der angegebenen Stage der angegebenen Bereitstellungspipeline bereit.

  • Verwenden Sie diese API, um alle Elemente bereitzustellen oder um bestimmte Elemente für die Bereitstellung auszuwählen. Wenn keine bestimmten Elemente ausgewählt sind, werden alle Elemente bereitgestellt.

  • Verwenden Sie die API, um die Bereitstellungsstufen der Pipeline aufzulisten und die erforderliche Phasen-ID für die Bereitstellung zu ermitteln.

  • Diese API ist in die APIs für lang andauernde Vorgänge integriert, um den Bereitstellungsstatus zu überwachen.

    • Rufen Sie den Vorgangsstatus ab, um festzustellen, ob der Vorgang mit der Api " Get Long Running – Get Operation state " abgeschlossen ist.
    • 24 Stunden nach Abschluss der Bereitstellung sind die erweiterten Bereitstellungsinformationen in derGet Operation Result-API verfügbar.

• Erstellen einer Bereitstellungspipeline: Erstellen einer Bereitstellungspipeline.

• Bereitstellungspipeline löschen: Löschen einer Bereitstellungspipeline.

• Aktualisieren der Bereitstellungspipeline: Aktualisieren einer Bereitstellungspipeline.

• Abrufen der Bereitstellungspipelinestage: Abrufen von Details zu einer Bereitstellungspipelinestage.

• Aktualisieren der Stage einer Bereitstellungspipeline: Aktualisieren der Stage einer Bereitstellungspipeline.

• Hinzufügen einer Bereitstellungspipelinerollenzuweisung: Hinzufügen einer Rollenzuweisung zu einer Bereitstellungspipeline.

• Löschen der Bereitstellungspipeline-Rollenzuweisung: Löschen einer Rollenzuweisung aus einer Bereitstellungspipeline.

• Rollenzuweisungen für die Bereitstellungspipeline auflisten: Auflisten aller Rollenzuweisungen für eine Bereitstellungspipeline.

• Zuweisen des Arbeitsbereichs zur Bereitstellungspipelinephase: Zuweisen eines Arbeitsbereichs zu einer bestimmten Bereitstellungspipelinephase.

• Aufheben der Zuweisung des Arbeitsbereichs aus der Bereitstellungspipelinephase: Aufheben der Zuweisung eines Arbeitsbereichs aus einer bestimmten Bereitstellungspipelinephase.

• Abrufen des Bereitstellungspipelinevorgangs: Abrufen von Details zu einem Bereitstellungspipelinevorgang.

• Bereitstellungspipeline-Vorgänge auflisten: Alle Vorgänge für eine Bereitstellungspipeline auflisten.

Sie können auch andere Fabric REST-API-Aufrufe verwenden, um verwandte Vorgänge auszuführen.

PowerShell-Beispiele

Die folgenden PowerShell-Skripts verdeutlichen, wie mehrere Automatisierungsprozesse ausgeführt werden. Verwenden Sie die Links in diesem Abschnitt, um den Text in einem PowerShell-Beispiel anzuzeigen oder zu kopieren.

Sie können auch den gesamten GitHub-Ordner Fabric-Samples herunterladen.

• Bereitstellen aller Inhalte

  Geben Sie die folgenden Informationen ein:

  • Pipelinename
  • Name der Quellphase
  • Name der Zielphase
  • Bereitstellungsnotizen (optional)
  • Prinzipaltyp. Wählen Sie " UserPrincipal " oder " ServicePrincipal" aus. Falls ein Dienstprinzipal vorhanden ist, stellen Sie auch Folgendes bereit:
    • Anwendungs-ID (Client) des Dienstprinzipals
    • die Mandanten-ID des Dienstprinzipals
    • Geheimniswert des Dienstprinzipals

• Selektive Bereitstellung

  Geben Sie die folgenden Informationen ein:

  • Pipelinename
  • Name der Quellphase
  • Name der Zielphase
  • Bereitzustellende Elemente (Anzeigename und Elementtyp der Elemente)
  • Bereitstellungsnotizen (optional)
  • Prinzipaltyp. Wählen Sie " UserPrincipal " oder " ServicePrincipal" aus. Falls ein Dienstprinzipal vorhanden ist, stellen Sie auch Folgendes bereit:
    • Anwendungs-ID (Client) des Dienstprinzipals
    • die Mandanten-ID des Dienstprinzipals
    • Geheimniswert des Dienstprinzipals

• Zuweisen zu einer neuen Bereitstellungspipeline und Bereitstellen

  Geben Sie die folgenden Informationen ein:

  • ID des Entwicklungsarbeitsbereichs
  • Name des neuen Produktionsarbeitsbereichs
  • Pipelinename
  • Bereitstellungsnotizen (optional)
  • Prinzipaltyp. Wählen Sie " UserPrincipal " oder " ServicePrincipal" aus. Falls ein Dienstprinzipal vorhanden ist, stellen Sie auch Folgendes bereit:
    • Anwendungs-ID (Client) des Dienstprinzipals
    • die Mandanten-ID des Dienstprinzipals
    • Geheimniswert des Dienstprinzipals

Überlegungen und Einschränkungen

Bei der Verwendung der Bereitstellungspipeline-APIs sind die folgenden Einschränkungen zu beachten:

• Alle Einschränkungen, die für die Bereitstellungspipeline gelten, gelten bei Verwendung der APIs. Weitere Informationen finden Sie unter Bewährte Methoden für Bereitstellungspipelines.

• Datenflüsse werden derzeit nicht unterstützt. Kunden, die Datenflüsse verwenden, können die Power BI-APIs verwenden.

• Nicht alle Bereitstellungsoptionen, die in den Power BI-APIs verfügbar sind, sind in Fabric verfügbar. Die folgenden APIs sind in der Bereitstellungsphase-Inhalts-API von Fabric nicht verfügbar:

  • allowPurgeData
  • allowTakeOver
  • allowSkipTilesWithMissingPrerequisites

  Um eine dieser APIs zu verwenden, verwenden Sie die Power BI-API , um sie bereitzustellen. Diese APIs funktionieren jedoch nur für Power BI-Elemente.

Zugehöriger Inhalt

• Erste Schritte mit Bereitstellungspipelines
• Bewährte Methoden für Bereitstellungspipelines
• Problembehandlung bei Bereitstellungspipelines