Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Microsoft Fabric-REST-APIs sollen Entwicklern helfen, Fabric zu automatisieren. Die Fabric-REST-API-Referenzseiten (Dokumentation) sind strukturiert, damit Entwickler die benötigten Informationen finden können.
Die Referenzseiten sind in zwei Hauptabschnitte unterteilt:
Kern-APIs – Kern-APIs stellen Informationen und Funktionen für alle Elemente in Microsoft Fabric bereit. Kern-APIs sind nicht für eine Workload spezifisch und können für alle Workloads verwendet werden. Kern-APIs sind CREATE-, Read-, Update- und Delete(CRUD)-APIs. Sie können sie verwenden, um Fabric-Elemente zusammen mit deren üblichen Eigenschaften zu erstellen oder zu aktualisieren. Die wichtigsten APIs können beim Ausführen von Batchvorgängen verwendet werden, die keine Manipulation bestimmter Eigenschaften, die für einen bestimmten Elementtyp spezifisch sind, erzwingen.
Workload-APIs – Workload-APIs zielen auf einen bestimmten Elementtyp in Fabric ab.
In den Abschnitten "Core" und "Workload reference page" werden alle APIs alphabetisch aufgeführt. Jeder Abschnitt enthält eine Übersicht, die eine Liste aller APIs im Abschnitt und eine alphabetische Liste der APIs im Abschnitt enthält.
Elementspezifischer Eintrag
Im elementspezifischen Abschnitt werden die Besonderheiten der einzelnen Elementtypen in Fabric beschrieben. Jeder Elementtypeintrag enthält:
Übersicht: Eine kurze Beschreibung des Elementtyps.
Endpunkte: Listet verfügbare Endpunkte für den Elementtyp sowie Details zu Parametern, Anforderungs- und Antwortformaten und Beispielen auf.
Modelle: Definiert das Datenmodell für den Elementtyp, wobei Eigenschaften und Typen angegeben werden.
Aktionen: Listet verfügbare Aktionen für den Elementtyp auf, einschließlich Details zu Parametern, Anforderungs- und Antwortformaten und Beispielen.
Verwenden Sie den elementspezifischen Eintrag, um die eindeutigen Aspekte der API im Zusammenhang mit einem bestimmten Elementtyp zu verstehen und Anleitungen zum Ausführen von Vorgängen im Zusammenhang mit diesem Elementtyp zu erhalten.
Referenzseitenstruktur
Jede Referenzseite weist die folgenden Abschnitte auf:
Übersicht – Ein kurzer Absatz oben im Artikel, der die API beschreibt.
Berechtigungen – Eine Liste der Benutzerberechtigungen, die zum Aufrufen der API erforderlich sind.
Erforderlicher Bereich – Eine Liste der Berechtigungen (auch als Bereiche bezeichnet), die die API erfordert.
Einschränkungen – (Optional) Eine Liste der Einschränkungen für die API.
Schnittstelle – Zeigt das HTTP-Formular der API an.
URI-Parameter – Eine Liste von Parametern, die zum Identifizieren einer bestimmten Ressource oder Ressource verwendet werden.
Anforderungstext – Eine Liste der Eigenschaften, die an die API übergeben werden können.
Antworten – Eine Liste möglicher Antworten aus der API.
Beispiele – Eine Liste von Beispielen, die zeigen, wie die API verwendet wird.
Definitionen – Parameter, die die Struktur und Eigenschaften eines Objekts definieren, die an die API übergeben werden können.
Die neue REFERENZstruktur der API-Dokumentation soll eine klare und konsistente Methode für den Zugriff auf und die Verwendung der API-Informationen bereitstellen. Durch die Trennung des CORE-Abschnitts und des elementspezifischen Eintrags hoffen wir, dass Entwickler die Informationen, die sie für die Integration in den Microsoft Fabric-Dienst benötigen, einfacher finden und verwenden können.
Wir freuen uns über Ihr Feedback und Vorschläge zur Verbesserung der Dokumentation und der API.