Ausführen der Metadatenüberprüfung

  • Artikel

In der folgenden kurzen exemplarischen Vorgehensweise erfahren Sie, wie Sie mithilfe der Scanner-APIs Metadaten aus den Fabric-Elementen Ihrer Organisation abrufen. Dabei wird davon ausgegangen, dass die Metadatenüberprüfung bereits durch ein*e Fabric Administrator*in in Ihrer Organisation eingerichtet wurde.

Eine Liste der Artefakt- und Subartefaktmetadaten, die die Metadatenüberprüfung zurückgibt, finden Sie in der Dokumentation zur API „Admin – WorkspaceInfo GetScanResult“.

Die Scanner-APIs lauten wie folgt: Sie unterstützen sowohl öffentliche Clouds als auch Sovereign Clouds.

Wichtig

Die App, die Sie für die Überprüfung entwickeln, kann sich entweder mithilfe eines standardmäßigen delegierten Administratorzugriffstokens oder eines Dienstprinzipals authentifizieren. Die beiden Authentifizierungsmöglichkeiten schließen sich gegenseitig aus. Bei Ausführung unter einem Dienstprinzipal dürfen für Ihre App keine für die Zustimmung des Power BI-Administrators erforderlichen Berechtigungen festgelegt werden . Weitere Informationen finden Sie unter Aktivieren der Dienstprinzipalauthentifizierung für schreibgeschützte Administrator-APIs.

Schritt 1: Durchführen einer vollständigen Überprüfung

Rufen Sie workspaces/modified ohne den Parameter modifiedSince auf, um eine vollständige Liste der Arbeitsbereichs-IDs im Mandanten zu erhalten. Durch diese Überprüfung werden alle Arbeitsbereiche im Mandanten abgerufen, einschließlich persönlicher Arbeitsbereiche und freigegebener Arbeitsbereiche. Wenn Sie persönliche Arbeitsbereiche von der Überprüfung ausschließen möchten, verwenden Sie den Parameter workspaces/modifiedexcludePersonalWorkspaces.

Unterteilen Sie die Liste in Blöcke mit maximal 100 Arbeitsbereichen.

Führen Sie für jeden Block aus 100 Arbeitsbereichen folgende Aktion aus:

Rufen Sie workspaces/getInfo auf, um einen Aufruf zur Überprüfung dieser 100 Arbeitsbereiche auszulösen. In der Antwort erhalten Sie den Wert der „scanId“, den Sie für die nächsten Schritte benötigen. Im Adressheader erhalten Sie auch den Uniform Resource Identifier (URI), den Sie im nächsten Schritt benötigen.

Hinweis

Es können nicht mehr als 16 Aufrufe gleichzeitig ausgeführt werden. Der Aufrufer sollte auf eine Antwort (erfolgreich/nicht erfolgreich) von der scanStatus-API warten, bevor er einen weiteren Aufruf ausführt.

Sollten einige von Ihnen erwartete Metadaten nicht zurückgegeben werden, wenden Sie sich an Ihre*n Fabric-Administrator*in, um sicherzustellen, dass alle relevanten Administratoroptionen aktiviert sind.

Verwenden Sie den URI aus dem Adressheader, den Sie durch den Aufruf von workspaces/getInfo erhalten haben, und rufen Sie workspaces/scanStatus/{scan_id} so lange ab, bis der Status „Erfolgreich“ zurückgegeben wird. Dieser Status bedeutet, dass das Ergebnis der Überprüfung bereitsteht. Es wird ein Abrufintervall von 30 bis 60 Sekunden empfohlen. Im Adressheader erhalten Sie auch den URI, den Sie im nächsten Schritt benötigen. Verwenden Sie diesen erst, wenn der Status „Erfolgreich“ lautet.

Verwenden Sie den URI aus dem Adressheader, den Sie durch den Aufruf von workspaces/scanStatus/{scan-id} erhalten haben, und lesen Sie die Daten mithilfe von workspaces/scanResult/{scan_id}. Die Daten enthalten die Liste der Arbeitsbereiche, Elementinformationen und andere Metadaten basierend auf den Parametern, die Sie im Aufruf von workspaces/getInfo übergeben haben.

Schritt 2: Durchführen einer inkrementellen Überprüfung

Nachdem Sie nun über alle Arbeitsbereiche sowie die Metadaten und Datenherkunft der Ressourcen verfügen, wird empfohlen, nur noch inkrementelle Überprüfungen durchzuführen, die auf die zuvor durchgeführte Überprüfung verweisen.

Rufen Sie workspaces/modified auf, und legen Sie dabei den Parameter modifiedSince auf die Startzeit der letzten Überprüfung fest. So erhalten Sie die geänderten Arbeitsbereiche, für die eine weitere Überprüfung erforderlich ist. Legen Sie den Parameter modifiedSince auf ein Datum innerhalb der letzten 30 Tage fest.

Unterteilen Sie diese Liste in Blöcke mit bis zu 100 Arbeitsbereichen. Rufen Sie die Daten für diese geänderten Arbeitsbereiche mithilfe der in Schritt 1 beschriebenen drei API-Aufrufe workspaces/getInfo, workspaces/scanStatus/{scan_id} und workspaces/scanResult/{scan_id} ab.

Überlegungen und Einschränkungen

  • Sementikmodelle, die nicht aktualisiert oder erneut veröffentlicht wurden, werden in API-Antworten zurückgegeben, jedoch ohne deren untergeordnete Artefaktinformationen und Ausdrücke. Die Antwort enthält beispielsweise den Namen und die Datenherkunft des Semantikmodells, jedoch nicht die Namen der Tabellen und Spalten im Semantikmodell.
  • Semantikmodelle, die nur DirectQuery-Tabellen enthalten, geben nur dann untergeordnete Artefaktmetadaten zurück, wenn eine Art von Aktion für das Semantikmodell ausgeführt wurde, z. B. jemand, der einen Bericht darüber erstellt, jemand, der einen Bericht basierend darauf anzeigt usw.
  • Echtzeitdatasets, Semantikmodelle mit Sicherheit auf Objektebene, Semantikmodelle mit einer Liveverbindung mit AS-Azure und einer lokalen AS-Instanz sowie Excel-Datasets mit voller Genauigkeit werden für Subartefakt-Metadaten nicht unterstützt. Bei nicht unterstützten Datasets wird in der Antwort der Grund zurückgegeben, warum die Subartefaktmetadaten aus dem Dataset nicht enthalten sind. Dieser befindet sich in einem Feld namens schemaRetrievalError, z. B. schemaRetrievalError: Nicht unterstützte Anforderung. RealTime-Datasets werden nicht unterstützt.
  • Die API gibt in freigegebenen Arbeitsbereichen keine Subartefakt-Metadaten für Semantikmodelle mit einer Größe über 1 GB zurück. In Premium-Arbeitsbereichen gibt es keine Größenbeschränkung für Semantikmodelle.

Lizenzierung

Für die Überprüfung von Metadaten ist keine spezielle Lizenz erforderlich. Es funktioniert für alle Metadaten Ihrer Mandanten, z. B. auch für Elemente in Nicht-Premium-Arbeitsbereichen.

Zugehöriger Inhalt