Pregled API-ja za održivost (pretpregled) u oblaku za održivost

  • Članak

Važno

Neke ili sve ove funkcije dostupne su kao dio izdanja pretpregleda. Sadržaj i funkcionalnost podložni su promjenama.

Microsoft Cloud for Sustainability pruža API-je za pristup podacima o emisijama koji se odnose na vašu Azure i Microsoft 365 upotrebu.

Točno računovodstvo ugljika zahtijeva dobre informacije od partnera, dobavljača i dobavljača. API-ji u oblaku za održivost omogućuju vam transparentnost emisija ugljika koje proizlaze iz upotrebe platforme Azure i Microsoft 365. Microsoftovo računovodstvo ugljika proteže se na sva tri opsega emisija s metodologijom koju je potvrdila treća strana. Koristi dosljedno i točno računovodstvo ugljika kako bi kvantificirao učinak Azurea i Microsoft 365 na ekološki otisak kupaca.

Pojedinosti o API-ju navedene su u referenci API-ja Microsoft Cloud for Sustainability . Oni uključuju dodatne informacije o operacijama, parametrima i odgovorima.

Važno

API Microsoft Cloud for Sustainability je trenutno u pretpregledu i podložan je promjenama. Vaši povijesni podaci o emisijama mogu se ažurirati i kako Microsoft poboljšava točnost i potpunost podataka. Ovaj pregled nije namijenjen za pravnu usklađenost, marketing ili izvješćivanje.

Početak rada s API-jevima za održivost u oblaku

Napomena

Ako vaša tvrtka ili ustanova želi pristupiti API-ju Microsoft Cloud for Sustainability (pretpregledu), pošaljite ovaj obrazac za prijavu.

Započnite s API-jevima pomoću sljedećih postupaka:

Podržani računi

  • Azure:API-ji Microsoft Cloud for Sustainability za Azure podržavaju EA Direct, MCA i MPA račune s izravnim Odnosi naplate kod Microsofta. Korisnici koji kupe Azure od davatelja rješenja u oblaku (CSP-a) nisu podržani i moraju izravno surađivati sa svojim CSP-om kako bi saznali više o svojim emisijama u oblaku. Naslijeđeni računi, računi temeljeni na kreditima, upisi u Kinu i računi vlade servisa Azure nisu podržani. Da biste provjerili vrstu računa, idite na Provjera vrste računa.

    Napomena

    Upotreba hibridnih pogodnosti servisa Azure trenutačno nije zabilježena niti se odražava u emisijama.

  • Microsoft 365: Microsoft Cloud for Sustainability API-ji za pretplate za podršku, tvrtke ili obrazovne pretplate za Microsoft 365 Microsoft 365 ili Office 365. Nacionalne/regionalne implementacije u oblaku, uključujući, ali ne ograničavajući se na Microsoftove oblake za američku vladu i Office 365 kojima upravlja 21Vianet, nisu podržane.

Prijavite se i stvorite instancu

Nakon što od Microsofta primite pristup Microsoft Cloud for Sustainability API-jevima, prijavite se sa svojim Azure Active Directory (Azure AD) vjerodajnicama.

Da biste pristupili Microsoft Cloud for Sustainability API-jevima, morate stvoriti instancu. Stvaranjem instance postajete administrator te instance. Administrator instance može u instancu dodati korisnike, grupe i aplikacije .

Pogledajte ovaj videozapis da biste dobili pregled korištenja API-ja i portala za održivost u oblaku:

Konfiguriranje izvora podataka i omogućivanje API-ja

Važno

Da biste uspješno omogućili pristup podacima svoje tvrtke ili ustanove, ovaj korak mora izvršiti odgovarajući administrator. Za račune servisa Azure MCA potreban je administrator računa za naplatu s ulogom računa za naplatu Čitatelj, suradnik ili vlasnika. Za račune servisa Azure EA potreban je administrator tvrtke ili administrator tvrtke – samo za čitanje. Provjerite svoju ulogu na portalu Azure. Za Microsoft 365 to je potrebna jedna od sljedećih uloga: globalni administrator, administrator sustava Exchange, administrator Skypea za tvrtke, administrator, globalna Čitatelj, SharePoint izvješće Čitatelj. Azure i administratori mogu stvarati instance ili se dodavati Microsoft 365 u instance da bi omogućili izvore podataka i omogućili API. Ako nemate potrebnu administratorsku ulogu za omogućivanje podataka, API možete istražiti samo pomoću demo podataka.

  1. Na kartici Izvori podataka uključite vezu da biste povezali podatke o servisu Azure ili Microsoft 365 emisije. Prije korištenja API-ja provjerite je li status naveden kao Dostupan . Ova radnja omogućuje podatke o emisijama koji se odnose na sve upise ili račune za naplatu za koje imate pristup. Ako nemate pristup podacima o emisijama, nastavite samo s demo podacima.

    Napomena

    Nakon omogućivanja izvor podataka može proći do 48 sati dok Microsoft 365 podaci o emisijama ne postanu dostupni. Onemogućavanje Microsoft 365 izvor podataka trajno će izbrisati povijesne Microsoft 365 podatke o emisijama.

    Izvori podataka.

  2. Odaberite karticu Upravljanje API-jem , a zatim Omogući .

    Omogućavanje API-ja generira primarne i sekundarne API ključeve za vašu instancu za upotrebu u API zahtjevima. Da biste regenerirali tipke, odaberite Ikona Osvježi. . Da biste kopirali tipke, odaberite Ikona Kopiraj. .

Zanima vas konfiguriranje aplikacije za pozivanje API-ja za održivost u oblaku? Pogledajte ovaj pokazni videozapis:

Isprobajte API-je

Na kartici Upravljanje API-jem odaberite Isprobajte API da biste istražili OData i Izvoz API-ja . Interaktivno pretražujte podatke o emisijama povezivanjem OData API-ja niske latencije s nadzornim pločama. Ili napravite vlastitu skupnu obradu prijenosom podataka o emisijama izravno na upotrebu Azure Data Lake Storage izvoznih API-ja. Portal za razvojne programere otvara se na novoj kartici na kojoj možete istražiti sheme zahtjeva i odgovora te uputiti zahtjeve uživo za Microsoft Cloud for Sustainability API-jeve.

Isprobajte OData API-je

  1. U lijevom navigacijskom oknu provjerite je li omogućeno grupiranje po oznaci i odaberite OData grupiranje da biste pregledali API-je servisa Azure i Microsoft 365 OData.

  2. Da biste poslali zahtjev uživo, odaberite Isprobaj. Unesite sva obavezna polja:

    • Autorizacija: automatski popunjen autorizacijski token
    • Ključ pretplate: automatski popunjen API ključem s kartice Upravljanje API-jem
    • ID prijave: vaš ID prijave, poznat i kao ID računa za naplatu. Samo Azure. Ako nemate pristup prijavi, API možete istražiti pomoću demo podataka unosom demopodataka u ovo polje.
    • instanceId: pronađeno u URL-u API portala Microsoft Cloud for Sustainability
    • ID-a klijenta:ID klijenta. Microsoft 365

    Probajte na stranici.

  3. Dodajte sve potrebne parametre upita. Pomaknite se do dna bočnog okna i odaberite Pošalji. HTTP odgovor prikazuje se na dnu okna.

Pogledajte ovaj videozapis da biste saznali više o API-jima za održivost u oblaku pomoću OData-e:

Isprobajte API-je za izvoz

  1. U lijevom navigacijskom oknu provjerite je li omogućeno grupiranje po oznaci i odaberite grupiranje Izvoz da biste počeli izvoziti podatke o emisijama i korištenju u podatkovno jezero. Odaberite RunExportJob.

  2. Odaberite Isprobaj. Unesite sva obavezna polja i odaberite Pošalji.

    • Autorizacija: automatski popunjen autorizacijski token
    • Ključ pretplate: automatski popunjen API ključem s kartice Upravljanje API-jem
    • instanceId: pronađeno u URL-u API portala Microsoft Cloud for Sustainability
    • exportJobType: Odaberite Azure ili Microsoft 365 odredite izvor podataka za podatke o emisijama i korištenju za izvoz.
    • demopodaci: Unesite "true" ako želite istražiti ovu funkcionalnost izvozom demo podataka.

  3. Kada odaberete Pošalji, pomaknite se prema dolje da biste vidjeli HTTP odgovor. Ako izvozite podatke sa servisa Azure, u odgovoru su navedeni ID-ovi za prijavu izvezenih podataka. Ako nemate pristup servisu Azure ili Microsoft 365 podacima, ova operacija neće uspjeti. Provjerite jeste li pravilno konfigurirali izvore podataka.

    U početku, odgovor pokazuje da posao ima NotStarted. Zadatak izvoza traje 2-3 minute, a pomoću ID-a posla možete provjeriti status izvoza pomoću API-ja ExportJobStatus . Provjerite je li posao uspio, što znači da su izvezeni podaci sada dostupni u pripremnoj pohrani bloba.

    LatestExportJob možete koristiti za pregled informacija o posljednjem poslu izvoza.

    ExportJobs API možete koristiti za pregled informacija o vašem povijesnom izvozu.

  4. Koristite ExportLocation API za dobivanje SAS URL-a. SAS URL istječe nakon dva sata. Kopirajte SAS URL da biste pristupili izvezenim podacima iz pripremne pohrane bloba.

  5. Podaci istječu 28 dana nakon pokretanja posla izvoza i moraju se kopirati prije isteka. U suprotnom, podaci se brišu s mjesta pripreme. Korisnici mogu u bilo kojem trenutku ponovno pokrenuti posao izvoza kako bi dobili drugu seriju podataka s istekom od 28 dana, uključujući najnoviju skup podataka. Postoji nekoliko načina za pristup izvezenim podacima.

    1. Preglednik spremišta na platformi Azure

      Instalirajte i otvorite Azure Storage Explorer. Odaberite gumb Otvori dijaloški okvir za povezivanje, a zatim odaberite spremnik ili direktorij ADLS Gen2. Odaberite URL potpisa zajedničkog pristupa (SAS) i zalijepite SAS URL iz četvrtog koraka u spremnik bloba ili direktorij SAS URL ulaz. Odaberite Dalje , a zatim Poveži se. Morate pronaći ili stvoriti spremnik na novom ili postojećem računu za pohranu koji će se koristiti za pohranu izvezenih podataka. Kopirajte Azure ili Microsoft 365 podatke iz spremišta bloba za uprizorenje i zalijepite u spremnik po vašem izboru.

    2. Koristite askopiju. Pomoću SAS URL-a iz četvrtog koraka i URL-a računa za pohranu na koji pohranjujete izvezene emisije (odredišni URL) pokrenite naredbu azcopy.exe:

      • azcopy login
      • azcopy list <SAS URL>
      • azcopy cp <SAS URL> <destination URL>

    3. Skripta iskre

      Koristite mssparkutils u Microsoft Fabric ili Synapse. Možete odabrati korištenje alternativnih biblioteka i okruženja.

      import subprocess
from notebookutils import mssparkutils

result = subprocess.run(['pip', 'install', 'azure-storage-blob'], capture_output=True)

# replace with SAS URI from API request
source_sas_url = 'https://<account_name>.blob.windows.net/<container_name>/<path>?<sas_token>'

start_index = source_sas_url.find('https://') + len('https://')
end_index = source_sas_url.find('.blob', start_index)
account_name = source_sas_url[start_index:end_index]
split = source_sas_url.split('?', 1)
domain_path = split[0]
sas_token = split[1]
container_name = domain_path.split('/')[3]

source_mount_point = '/src'
destination_mount_point = '/dest'

mssparkutils.fs.unmount(source_mount_point)
mssparkutils.fs.mount(
    f'abfss://{container_name}@{account_name}.blob.core.windows.net',
    source_mount_point,
    { 'sasToken': sas_token })

mssparkutils.fs.unmount(destination_mount_point)
mssparkutils.fs.mount( 
    'abfss://<destinationPath>', # replace with destination connection string
    destination_mount_point)

mssparkutils.fs.cp(src_path, dest_path, True)

Ogledni upiti

Kratki popis OData oglednih upita za rad s API-jevima potražite u primjerima OData upita.

Dodjela dozvola

Microsoft Cloud for Sustainability Pristup API-jevima ograničen je na korisnike u vašoj tvrtki ili ustanovi koje administrator instance dodaje u aplikaciju. Korisnik može biti jedan korisnik, grupa ili aplikacija. Računi gostiju nisu podržani. Mogu se dodijeliti tri vrste uloga:

  • Preglednik: može pregledavati sve stranice unutar API-ja Microsoft Cloud for Sustainability .
  • suradnik: Može komunicirati sa svim stranicama API portala Microsoft Cloud for Sustainability . Nije moguće dodati ili ukloniti korisnike.
  • Administrator: sve dostupne dozvole, uključujući mogućnost dodavanja ili uklanjanja korisnika.

Napomena

Suradnici i administratori ne mogu onemogućiti ili omogućiti Microsoft 365 izvor podataka osim ako nisu globalni administrator, administrator sustava Exchange, administrator Skypea za tvrtke, administrator, SharePoint globalna Čitatelj ili Čitatelj izvješća.

Da biste dodali korisnike, grupe ili aplikacije kao administratora:

  1. Odaberite karticu Dozvole , a zatim Dodaj korisnike.
  2. Pomoću polja Pretraživanje pronađite Azure AD korisnika, aplikaciju ili grupu koju želite dodati.
  3. Odaberite dodjelu uloge, a zatim Spremi.

Upravljanje instancama

Idite do ikone Ikona instance instance da biste pronašli popis svih instanci, stvorili instance ili uklonili instance.

Prikaz korištenja API-ja

Pogledajte detalje o upotrebi API-ja u stvarnom vremenu.

  1. Idite na karticu Upravljanje API-jem , a zatim odaberite Korištenje .
  2. Odaberite vremenski okvir za prikaz.

Stranica korištenja API-ja sadrži tri odjeljka:

  • API pozivi: grafikon koji vizualizira zbirni broj poziva API-ju u odabranoj vremenski okvir.
  • Prijenos podataka: grafikon koji prikazuje količinu podataka prenesenih putem API-ja u odabranoj vremenski okvir.
  • Operacije: tablica s recima za svaku dostupnu operaciju API-ja i pojedinostima o korištenju operacija.

Najčešće postavljana pitanja

Kako Microsoft izračunava emisije ugljika u oblaku koje je API stavio na raspolaganje?

Informacije o Microsoftovoj metodologiji izračuna potražite u Microsoft Cloud for Sustainability metodologiji izračuna API-ja.

Gdje mogu saznati više o pisanju upita pomoću OData-e?

Dodatne informacije o OData-i potražite u pregledu mogućnosti upita.

Gdje se pohranjuju podaci koji se koriste za izradu ovog izvješća?

Podaci se pohranjuju u Sjedinjenim Državama.

Zašto ne mogu vidjeti podatke o emisijama za prethodni mjesec?

Podaci o emisijama za određeni mjesec bit će dostupni do 14. dana nakon kraja tog mjeseca (uključujući dane koji nisu poslovni dani).

Ne mogu stvoriti instancu. Zašto?

Možda pokušavate pristupiti portalu API-ja za oblak za održivost pomoću računa koji je povezan s drugim ID-om klijenta glavnog računala od onog navedenog na obrascu za uključivanje. Ta se situacija može dogoditi kada koristite gostov račun. Računi gostiju nisu podržani. Ako želite da se ukrcamo na drugog stanara, ponovno pošaljite obrazac za ukrcavanje.

Imam drugu ID klijenta za Microsoft 365 i Azure. Mogu li i dalje koristiti Microsoft Cloud for Sustainability API?

I dalje možete pristupiti API-jevima, ali portal ne podržava više klijenata po instanci. Te klijente morate zasebno ukrcati na API-je.

Kako konfigurirati aplikaciju za pozivanje API-ja Microsoft Cloud for Sustainability ?

Zanima vas konfiguriranje aplikacije za pozivanje API-ja za održivost u oblaku? Pogledajte ovaj pokazni videozapis:

Na portalu Azure otvorite svoje Azure Active Directory, odaberite Registracije aplikacija, a zatim na + Nova registracija. Na novoj stranici za registraciju navedite naziv registracije aplikacije, prilagodite opcije svojim potrebama, a zatim odaberite Registriraj se. Idite na stranicu, odaberite Azure AD oštricu Enterprise aplikacije, postavite vrstu aplikacije na Microsoftove aplikacije i pretražite prema nazivu aplikacije MCFS SDS. Parametar ApplicationId koji ste prošli u naredbi New-AzADServicePrincipal potreban tijekom uključivanja je ApplicationId API-ja Microsoft Cloud for Sustainability () pomoću kojeg ste stvorili instancu (c3163bf1-092f-436b-b260-7ade5973e5b9poslovnu aplikaciju) Microsoft Cloud for Sustainability registracije API aplikacije u vlastitom klijentu.

S tim na mjestu sada možete otići na stranicu za registraciju aplikacije i odabrati oštricu dopuštenja za API. Da biste dodali dopuštenje za registraciju aplikacije da biste mogli pozvati Microsoft Cloud for Sustainability API, odaberite + Dodaj dopuštenje, nakon čega slijede API-ji koje koristi moja tvrtka ili ustanova. Zatim pretražite ApplicationId API-ja Microsoft Cloud for Sustainability (c3163bf1-092f-436b-b260-7ade5973e5b9), odaberite MCFS SDS , a zatim odaberitedopuštenje App.Emissions.Read na listi dopuštenja aplikacije.

Ova dozvola za vrstu aplikacije mora dobiti pristanak administratora odabirom pristanka administratora za {your-tenant}.

Na kraju, posjetite Microsoft Cloud for Sustainability početnu stranicu API-ja, idite do oznake Dozvole , a zatim odaberite + Dodaj. Na bočnoj ploči koja će se prikazati odaberite Preglednik kao ulogu u unosu korisnika, grupe ili aplikacije i nastavite tražiti registraciju aplikacije. Odaberite Spremi.

Dobivam pristupni token za svoju prijavu, što je URL resursa?

c3163bf1-092f-436b-b260-7ade5973e5b9/.default

Koliko je povijesnih podataka dostupno?

  • Azure: Podaci o upotrebi i emisijama obuhvaćaju posljednjih pet godina podataka povezanih s upisom.
  • Microsoft 365: Podaci o emisijama obuhvaćaju posljednjih 12 mjeseci podataka povezanih s pretplatom Microsoft 365 .

Izjava o odricanju odgovornosti

API Microsoft Cloud for Sustainability (pregled) temelji se na industrijskim standardima za izračun ugljika poslužitelja i pruža opće procjene kako bi pomogao organizacijama da steknu uvid u emisije ugljika IT infrastrukture povezane s korištenjem usluga u oblaku za Azure. Nalazi, tumačenja i zaključci predstavljeni API-jem Microsoft Cloud for Sustainability (pregled), uključujući izračune, nisu posebni savjeti ili preporuke. Izražene informacije i stavovi mogu se promijeniti bez prethodne najave. API Microsoft Cloud for Sustainability (pregled) pruža se takav kakav jest, bez ikakve izjave ili jamstva bilo koje vrste, bilo izražen ili impliciran, uključujući, bez ograničenja, bilo kakve izjave ili potvrde u vezi s upotrebom, rezultatima ili izvedbom Microsoft Cloud for Sustainability API-ja (pregled), njegovom prikladnošću, točnošću, pouzdanošću ili točnošću. Cjelokupni rizik u vezi s korištenjem API-ja Microsoft Cloud for Sustainability (pregled) preuzimate vi. Microsoft ne preuzima odgovornost za korištenje API-ja Microsoft Cloud for Sustainability (pretpregled). Microsoft ni u kojem slučaju neće biti odgovoran za dodatnu izravnu ili neizravnu štetu, uključujući izgubljenu dobit, izgubljenu štednju ili bilo kakvu slučajnu ili posljedičnu štetu koja proizlazi iz bilo kakvih nedostataka ili korištenja API-ja (pregled), čak i Microsoft Cloud for Sustainability ako je Microsoft obaviješten o mogućnosti takve štete.

Pogledajte

Microsoft Cloud for Sustainability API OData upit primjeri
Microsoft Cloud for Sustainability API metodologije
Microsoft Cloud for Sustainability izračuna API