Prvo pogledajte izvještaj o korištenju SharePoint API-ja

Prije nekoliko dana pojavio se novi izvještaj na stranici dnevnika promjena Graph API-ja i na stranici sa dokumentacijom /beta, odnosno izvještaj o korištenju SharePoint API-ja. U tom trenutku, krajnja tačka je vratila a 403 Zabranjeno greška sa “Zakupac {tenantId} nije omogućen za ovu funkciju pregleda.“, vrlo sličan onom prikazanom u primjeru 10 u dokumentaciji ili ekranu ispod, pa sam mislio da ću ga dodati na svoju listu “za kraj” i raditi na tome kasnije.

Pa, izgleda da je došao taj dan, jer mogu dobiti odgovarajuće podatke unutar svog stanara. Prije nego što govorimo o tome šta se može dobiti radom sa novim izvještajem, moramo spomenuti još jednu novinu. Naime, izvještaj prvo mora biti omogućen, putem novouvedene kontrole postavki izvještaja apiUsageReportMetrics. Tek nakon što omogućite prikupljanje podataka unutar vašeg stanara, možete očekivati ​​da će izvještaj otkriti podatke o stvarnom korištenju. Dok se to ne dogodi, naići ćete na drugog 403 Zabranjeno greška kao što je prikazano ispod:

Kako omogućiti metriku izvještaja o korištenju SharePoint API-ja

Dakle, prije svega, trebate omogućiti/onemogućiti prikupljanje podataka za ovaj izvještaj preko enableApiUsageReport krajnje tačke. Za prebacivanje trebat će vam administratorski račun i aplikacije ReportSettings.ReadWrite.All dodana dozvola za delegiranje. Prema dokumentaciji trenutno ne postoji podrška za dozvole aplikacija. S druge strane, čini se da krajnje tačke trenutno ne provode potrebne dozvole, a mogao sam ih prebaciti preko Globalnog administratora samo sa Reports.Read.All opseg dodijeljen u Graph Exploreru. Međutim, svakako slijedite službenu dokumentaciju o ovome.

Da biste omogućili prikupljanje podataka za izvještaj o korištenju SharePoint API-ja, izdajte POST zahtjev za enableApiUsageReport krajnju tačku i obezbijediti sljedeće korisno opterećenje:

POST https://graph.microsoft.com/beta/admin/reportSettings/sharePoint/enableApiUsageReport

{
  "metric": "EgressReport"
}

Uspješno izvršenje će rezultirati a 200 OK odgovor, s onboardingStatus vraćen kao omogućavanje.

Za provjeru statusa koristite GET zahtjev protiv /admin/reportSettings/sharePoint/apiUsageReportMetrics krajnja tačka:

GET https://graph.microsoft.com/beta/admin/reportSettings/sharePoint/apiUsageReportMetrics

Zanimljivo je da metoda GET ne radi kako treba ReportSettings.Read.All svaka dozvola 🙂

Rad sa izvještajem o korištenju SharePoint API-ja

Nakon što omogućite prikupljanje podataka za izvještaj o korištenju SharePoint API-ja i prođe dovoljno vremena, odgovarajući podaci o korištenju bit će izloženi pod /beta/reports/getSharePointApiUsage krajnja tačka. Moja preporuka je da pričekate nekoliko dana jer se podaci izvještaja ionako generiraju na dnevnoj bazi. Dok podaci ne postanu dostupni, očekujte da vidite 403 greške poput onih prikazanih u prethodnim odjeljcima.

Što se tiče dozvola, trebat će vam “standardni” Reports.Read.All opseg i korisnički nalog s odgovarajućim dozvolama (na primjer, uloga čitača izvještaja). Opet, podržano je samo ovlaštenje delegiranja. Imajte na umu da se izvještaj trenutno pregleda i da je dostupan samo pod /beta krajnja tačka, tako da bi vaši zahtjevi trebali biti izrađeni u skladu s tim.

Da biste dobili podatke izvještaja za posljednjih 30 dana, koristite sljedeći upit:

GET https://graph.microsoft.com/beta/reports/getSharePointApiUsage(period='D30')

Kao što možete vidjeti na slici iznad, izlaz je vrlo sličan izlazu izvještaja o korištenju Graph API-ja koji je prethodno pokriven. Trenutno su prikazane sljedeće kolone:

• UsageDateTime – datum za koji je trenutni unos izvještaja, jedan dnevno.
• ServiceArea – usluga, jedna od četiri gore navedene.
• TenantId – GUID stanara… koji samo dodaje buku IMO.
• AppId – GUID za aplikaciju, svaka aplikacija treba da ima svoj unos po danu.
• Korišćenje MB – količina podataka (u MB) koje koriste API operacije koje obavlja određena aplikacija za taj dan.
• UsageRequests – broj API operacija koje je izvršila određena aplikacija za taj dan.
• ActiveApps – ovo polje je navedeno u dokumentaciji, ali se trenutno ne vraća. Čini se da prikazuje broj jedinstvenih aplikacija sa aktivnošću za dan i vjerovatno će biti dostupan samo na “kumulativnim” unosima.

Opet slično izvještaju o upotrebi Graph API-ja, podržan je sljedeći skup parametara upita:

• appId – filtrirati izvještaj prema, na primjer, određenoj vrijednosti AppID appId=’972bb84a-1d27-4bd3-8306-6b8e57679e8c’ (odgovori Microsoft Defender za aplikacije u oblaku – API-ji).
• period – dobiti podatke izvještaja za određeni vremenski period. Za razliku od drugih krajnjih tačaka izvještaja, trenutno su podržane samo sljedeće vrijednosti: D1, D7, D30. na primjer: period=’D30′.
• datum – dobiti podatke izvještaja za određene datume, u formatu GGGG-MM-DD. na primjer: datum=2026-02-04.

Izveštaj takođe podržava $format parametar koji kontrolira izlazni format. Zadana vrijednost je JSON i ne biste trebali koristiti nijednu drugu vrijednost. Obavezno provjerite službenu dokumentaciju za dodatne informacije i primjere.

Abstract

Ukratko, sada imamo dostupan izvještaj o metrikama korištenja SharePoint API-ja, koji nam daje iste podatke kao izvještaj o upotrebi API-ja za Graph, ali za SPO uslugu. Ne razumem zašto je Microsoftu bila potrebna posebna krajnja tačka za ovo, a isto važi i za zahtev da se prvo omogući prikupljanje podataka za izveštaj. Samo još jedan primjer da je Graf “labavo povezana” kolekcija krajnjih tačaka, pri čemu svaki tim unutar Microsofta radi svoje stvari i zanemaruje bilo kakvu ideju o uniformnosti.

Osim toga, prošlo je više od godinu dana otkako smo primili izvještaje o korištenju Graph API-ja, a nismo čuli ništa od Microsofta u vezi s njihovim planovima. Hoće li uvesti novi oblik kontrole gasa ili će izvještaji biti samo informativni? Pitanje na koje trenutno niko ne želi da odgovori.

U svakom slučaju, veća pokrivenost je uvijek dobra stvar u mojoj knjizi, tako da radim svoj dio da proširim vijest.