Dela via


Köra metadatagenomsökning

Följande korta genomgång visar hur du använder skanner-API:erna för att hämta metadata från organisationens infrastrukturobjekt. Det förutsätter att en infrastrukturadministratör har konfigurerat metadatagenomsökning i din organisation.

En lista över artefakt- och underartsmetadata som metadatagenomsökning returnerar finns i dokumentationen för API:et Admin – WorkspaceInfo GetScanResult.

Följande är skanner-API:erna. De stöder både offentliga och nationella moln.

Viktigt!

Appen som du utvecklar för genomsökning kan autentiseras med hjälp av antingen en standarddelegeringstoken för administratörsåtkomst eller ett tjänsthuvudnamn. De två autentiseringssökvägarna är ömsesidigt uteslutande. När du kör under ett huvudnamn för tjänsten får det inte finnas några behörigheter som krävs för Power BI-administratörsmedgivande för din app. Mer information finns i Aktivera autentisering med tjänstens huvudnamn för skrivskyddade administratörs-API:er.

Steg 1: Utföra en fullständig genomsökning

Anropa arbetsytor/ändrade utan parametern modifiedSince för att hämta den fullständiga listan över arbetsyte-ID:t i klientorganisationen. Genomsökningen hämtar alla arbetsytor i klientorganisationen, inklusive personliga arbetsytor och delade arbetsytor. Om du vill undanta personliga arbetsytor från genomsökningen använder du parametern workspaces/modified excludePersonalWorkspaces .

Dela upp listan i segment med högst 100 arbetsytor.

För varje segment på 100 arbetsytor:

Anropa arbetsytor/getInfo för att utlösa ett genomsökningsanrop för dessa 100 arbetsytor. Du får scanId i svaret som ska användas i nästa steg. I platsrubriken får du även URI (Uniform Resource Identifier) för att anropa för nästa steg.

Kommentar

Högst 16 anrop kan göras samtidigt. Anroparen bör vänta tills en genomsökning lyckades/misslyckades från scanStatus-API:et innan ett annat anrop anropas.

Om vissa metadata som du förväntade dig inte returneras kontrollerar du med infrastrukturresursadministratören att de har aktiverat alla relevanta administratörsväxlar.

Använd URI:n från platsrubriken som du fick från att anropa arbetsytor/getInfo och avsöka arbetsytor/scanStatus/{scan_id} tills statusen som returnerades är "Lyckades". Den här statusen innebär att genomsökningsresultatet är klart. Vi rekommenderar att du använder ett avsökningsintervall på 30–60 sekunder. I platsrubriken får du även den URI som ska anropas i nästa steg. Använd den först när statusen är "Lyckades".

Använd URI:n från platsrubriken som du fick från att anropa arbetsytor/scanStatus/{scan-id} och läsa data med hjälp av arbetsytor/scanResult/{scan_id}. Data innehåller listan över arbetsytor, objektinformation och andra metadata baserat på parametrarna som skickas i arbetsytorna/getInfo-anropet .

Steg 2: Utföra en inkrementell genomsökning

Nu när du har alla arbetsytor och metadata och ursprung för deras tillgångar rekommenderar vi att du endast utför inkrementella genomsökningar som refererar till den tidigare genomsökningen som du gjorde.

Anropa arbetsytor/ändrade med parametern modifiedSince inställd på starttiden för den senaste genomsökningen för att hämta de arbetsytor som har ändrats och som därför kräver en ny genomsökning. Parametern modifiedSince bör anges för ett datum inom de senaste 30 dagarna.

Dela upp den här listan i segment på upp till 100 arbetsytor och hämta data för dessa ändrade arbetsytor med hjälp av de tre API-anropen, arbetsytor/getInfo, arbetsytor/scanStatus/{scan_id} och arbetsytor/scanResult/{scan_id}, enligt beskrivningen i steg 1.

Beaktanden och begränsningar

  • semantiska modeller som inte har uppdaterats eller ompublicerats returneras i API-svar men utan deras underordnad information och uttryck. Till exempel inkluderas semantisk modellnamn och ursprung i svaret, men inte semantikmodellens tabell- och kolumnnamn.
  • semantiska modeller som endast innehåller DirectQuery-tabeller returnerar endast metadata för subartifact om någon form av åtgärd har vidtagits för semantikmodellen, till exempel någon som skapar en rapport ovanpå den, någon som visar en rapport baserat på den osv.
  • Realtidsdatauppsättningar, semantiska modeller med säkerhet på objektnivå, semantiska modeller med en live-anslutning till AS-Azure och AS lokalt, och Excel-datauppsättningar med fullständig återgivning stöds inte för underartsmetadata. För datauppsättningar som inte stöds returnerar svaret orsaken till att inte hämta underartsmetadata från datauppsättningen. Det finns i ett fält med namnet schemaRetrievalError, till exempel schemaRetrievalError: Begäran stöds inte. Realtidsdatauppsättning stöds inte.
  • API:et returnerar inte underartsmetadata för semantiska modeller som är större än 1 GB på delade arbetsytor. I Premium-arbetsytor finns det ingen storleksbegränsning för semantiska modeller.

Licensiering

Metadatagenomsökning kräver ingen särskild licens. Det fungerar för alla klientorganisationens metadata, inklusive objekt som finns i arbetsytor som inte är Premium-arbetsytor.