Delen via

Overzicht van Cloud for Sustainability API (preview)

  • Artikel

Gratis proefperiode

Belangrijk

Een gedeelte van of alle functionaliteit is beschikbaar als onderdeel van een preview-release. De inhoud en functionaliteit zijn aan verandering onderhevig.

Microsoft Cloud for Sustainability biedt API's voor toegang tot uitstootgegevens met betrekking tot uw Azure- en Microsoft 365-gebruik.

Nauwkeurige CO2-boekhouding vereist goede informatie van partners, leveranciers en toeleveranciers. De API's van Cloud for Sustainability bieden u transparantie over de CO2-uitstoot die wordt gegenereerd door uw gebruik van Azure en Microsoft 365. De CO2-boekhouding van Microsoft strekt zich uit over elk van de drie scopes voor uitstoot met een door derden gevalideerde methodologie. Het werkt met een consistente en nauwkeurige CO2-boekhouding om het effect van Azure en Microsoft 365 op de ecologische voetafdruk van klanten te kwantificeren.

Details van de API staan vermeld in de referentie voor Microsoft Cloud for Sustainability-API. Ze bevatten aanvullende informatie over bewerkingen, parameters en reacties.

Belangrijk

De Microsoft Cloud for Sustainability API is momenteel in preview en kan wijzigingen ondergaan. Uw historische uitstootcijfers worden mogelijk ook bijgewerkt zodra Microsoft verbeteringen aanbrengt in de nauwkeurigheid en volledigheid van gegevens. Deze preview is niet bedoeld voor doeleinden met betrekking tot wettelijke naleving, marketing of rapportage.

Aan de slag met Cloud for Sustainability API's

Opmerking

Als uw organisatie toegang wil krijgen tot de Microsoft Cloud for Sustainability API (preview), dient u dit registratieformulier in.

Ga aan de slag met de API's met de volgende procedures:

Ondersteunde accounts

  • Azure : Microsoft Cloud for Sustainability API's voor Azure ondersteunen EA Direct-, MCA- en MPA-accounts met directe facturering Relaties met Microsoft. Klanten die Azure aanschaffen bij een Cloud Solution Provider (CSP) worden niet ondersteund en moeten rechtstreeks met hun CSP samenwerken om meer te weten te komen over de uitstoot van hun cloud. Verouderde accounts, accounts op basis van tegoeden, China-inschrijvingen en Azure Government-accounts worden niet ondersteund. Ga naar Het type rekening controleren om uw rekeningtype te controleren.

    Notitie

    Azure Hybride voordeel Het gebruik wordt momenteel niet vastgelegd of weergegeven in de emissies.

  • Microsoft 365: Microsoft Cloud for Sustainability API's voor Microsoft 365 Ondersteun zakelijke, zakelijke of educatieve abonnementen voor Microsoft 365 of Office 365. Nationale/regionale cloudimplementaties, met inbegrip van maar niet beperkt tot de US Government-clouds van Microsoft en Office 365 beheerd door 21Vianet, worden niet ondersteund.

Aanmelden en een exemplaar maken

Nadat u toegang tot de Microsoft Cloud for Sustainability-API's van Microsoft hebt gekregen, meldt u zich aan met uw Azure Microsoft Entra ID-referenties.

U moet een exemplaar maken om toegang te krijgen tot de Microsoft Cloud for Sustainability API's. Door het exemplaar te maken, wordt u de beheerder van dat exemplaar. De beheerder van het exemplaar kan gebruikers, groepen en toepassingen toevoegen aan het exemplaar.

Bekijk deze video voor een overzicht van het gebruik van API's en de portal van Cloud for Sustainability:

Gegevensbronnen configureren en de API's inschakelen

Belangrijk

Om toegang tot de gegevens van uw organisatie mogelijk te maken, moet deze stap worden uitgevoerd door de relevante beheerder. Voor Azure MCA-rekeningen is een factureringsrekeningsbeheerder met een rol als lezer, inzender of eigenaar van factureringsrekeningen vereist. Voor Azure EA-accounts is een ondernemingsbeheerder of ondernemingsbeheerder - alleen-lezen vereist. Controleer uw rol in Azure Portal. Voor Microsoft 365 is een van de volgende rollen vereist: Exchange-beheerder, Skype voor Bedrijven-beheerder, SharePoint-beheerder, Algemene lezer, Rapportlezer. De Azure- en Microsoft 365-beheerder kunnen exemplaren maken of worden toegevoegd aan exemplaren om gegevensbronnen te activeren en de API in te schakelen. Als u niet over de vereiste beheerdersrol beschikt om toegang te krijgen tot de gegevens, kunt u de API alleen met behulp van demogegevens verkennen.

  1. Zet op het tabblad Gegevensbronnen de verbinding aan om Azure- of Microsoft 365-uitstootgegevens te verbinden. Controleer of de status als Beschikbaar staat vermeld voordat u de API's gebruikt. Met deze actie worden uitstootgegevens ingeschakeld die betrekking hebben op alle inschrijvingen of factureringsaccounts waartoe u toegang hebt. Als u geen toegang hebt tot uitstootgegevens, ga dan verder met alleen demogegevens.

    Notitie

    Het kan tot 48 uur duren voordat Microsoft 365-uitstootgegevens beschikbaar zijn nadat de gegevensbron is ingeschakeld. Als de Microsoft 365-gegevensbron wordt uitgeschakeld, worden historische Microsoft 365-uitstootgegevens permanent verwijderd.

    Gegevensbronnen

  2. Selecteer het tabblad API-beher en selecteer vervolgens Inschakelen.

    Als u de API inschakelt, worden primaire en secundaire API-sleutels gegenereerd die uw exemplaar kan gebruiken in API-aanvragen. Selecteer pictogram Vernieuwen. om de sleutels opnieuw te genereren. Selecteer Pictogram Kopiëren. om sleutels te kopiëren.

Geïnteresseerd in het configureren van een app om de API van Cloud for Sustainability aan te roepen? Deze demo bekijken:

De API's uitproberen

Selecteer op het tabblad API-beheer de optie API proberen om OData te verkennen en API's te exporteren. Vraag interactief uw uitstootgegevens op door OData-API's met lage latentie aan uw dashboards te koppelen. Of voer uw eigen bulkverwerking uit door uw uitstootgegevens rechtstreeks over te dragen naar uw Azure Data Lake Storage met behulp van API's exporteren. Er wordt een ontwikkelaarsportal geopend op een nieuw tabblad waar u de aanvraag- en Export 's kunt verkennen en live aanvragen kunt indienen tegen de Microsoft Cloud for Sustainability API's.

OData API's proberen

  1. Controleer in het linkernavigatievenster of Groeperen op tag is ingeschakeld en selecteer vervolgens de OData-groepering om de Azure- en Microsoft 365 OData-API's te bekijken.

  2. Selecteer Probeer het zelf om een live aanvraag in te dienen. Voer alle vereiste velden in:

    • Autorisatie : Automatisch ingevuld autorisatietoken
    • Abonnementssleutel : Automatisch ingevuld met de API-sleutel van de API-beheer tabblad
    • inschrijvings-ID : Uw inschrijvings-ID, ook wel bekend als uw factureringsaccount-ID. Alleen Azure. Als u geen toegang hebt tot een inschrijving, kunt u de API verkennen met behulp van demogegevens door demodata in dit veld in te voeren.
    • exemplaar-ID : Gevonden in de URL van voor de Microsoft Cloud for Sustainability API-portaal
    • huurderID : Microsoft 365 huurder-ID.

    Pagina Probeer het zelf.

  3. Voeg alle benodigde queryparameters toe. Scrol naar de onderkant van het deelvenster aan de zijkant en selecteer Verzenden. De HTTP-respons verschijnt onder aan het deelvenster.

Bekijk deze video voor meer informatie over API's van Cloud for Sustainability met OData:

API's exporteren proberen

  1. Controleer in het linkernavigatievenster of Groeperen op tag is ingeschakeld en selecteer de groepering Exporteren om te beginnen met het exporteren van uitstoot- en gebruiksgegevens naar uw data lake. Selecteer RunExportJob.

  2. Selecteer Probeer het. Voer alle vereiste velden in en selecteer Verzenden.

    • Autorisatie : Automatisch ingevuld autorisatietoken
    • Abonnementssleutel : Automatisch ingevuld met de API-sleutel van de API-beheer tabblad
    • exemplaar-ID : Gevonden in de URL van voor de Microsoft Cloud for Sustainability API-portaal
    • exportJobType : Selecteer Azure of Microsoft 365 om gegevensbron aan te wijzen voor het exporteren van emissie- en gebruiksgegevens.
    • demodata : Voer "true" in als u deze functionaliteit wilt verkennen door demogegevens te exporteren.

  3. Nadat u Verzenden hebt geselecteerd, bladert u omlaag om de HTTP-respons te bekijken. Als u Azure-gegevens exporteert, geeft de respons de inschrijvings-id's aan voor de geëxporteerde gegevens. Als u geen toegang hebt tot Azure- of Microsoft 365-gegevens, zal deze bewerking niet lukken. Controleer of u uw gegevensbronnen correct hebt geconfigureerd.

    In eerste instantie geeft de respons aan dat de taak niet is gestart. De exporttaak duurt 2-3 minuten en u kunt de taak-id gebruiken om de status van de export te controleren met behulp van de API ExportJobStatus. Controleer of de taak is geslaagd. Dit betekent dat de geëxporteerde gegevens nu beschikbaar zijn in de blobopslag voor fasering.

    U kunt LatestExportJob gebruiken om informatie over uw laatste exporttaak te bekijken.

    U kunt de API ExportJobs gebruiken om informatie over uw historische exports te bekijken.

  4. Gebruik de API ExportLocation om de SAS-URL te verkrijgen. De SAS-URL verloopt na één uur. Kopieer de SAS-URL om toegang te krijgen tot de geëxporteerde gegevens uit de faseringsblobopslag.

  5. De gegevens verlopen 28 dagen nadat de exporttaak is uitgevoerd en moeten worden gekopieerd voordat ze vervallen. Anders worden de gegevens verwijderd van de faseringslocatie. Gebruikers kunnen een exporttaak op elk gewenst moment opnieuw uitvoeren om een nieuwe batch gegevens te verkrijgen met een houdbaarheidsdatum van 28 dagen en met de meest recente gegevensset. Er zijn een paar manieren om toegang te krijgen tot de geëxporteerde gegevens.

    1. Azure Storage Explorer

      Installeer en open Azure Storage Explorer. Selecteer de knop Dialoogvenster Verbinding openen en selecteer vervolgens ADLS Gen2-container of -directory. Selecteer Shared Access Signature URL (SAS) en plak de SAS-URL uit stap 4 in Blob-container of directory SAS-URL. Selecteer Volgende en vervolgens Verbinden. U moet een container zoeken of maken in een nieuw of bestaand opslagaccount om deze geëxporteerde gegevens op te slaan. Kopieer de Azure- of Microsoft 365-gegevens uit de faseringsblobopslag en plak deze in de container van uw keuze.

    2. Gebruik azcopy. Voer de opdracht azcopy.exe uit met behulp van de SAS-URL uit stap 4 en de URL voor het opslagaccount waar u uw geëxporteerde uitstoot opslaat (bestemmings-URL):

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

    3. Spark-script

      Gebruik mssparkutils in Microsoft Fabric of Synapse. U kunt ervoor kiezen om alternatieve bibliotheken en omgevingen te gebruiken.

      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)

Voorbeeldquery's

Voor een korte lijst met OData-voorbeeldquery's om met de API's te werken, gaat u naar Voorbeelden van OData-query's.

Machtigingen toewijzen

Toegang tot Microsoft Cloud for Sustainability API's is beperkt tot gebruikers in uw organisatie die een beheerder van een exemplaar toevoegt aan de toepassing. Een gebruiker kan een enkele gebruiker, groep of toepassing zijn. Gastaccounts worden niet ondersteund. Er zijn drie typen rollen die u kunt toewijzen:

  • kijker : Kan alle pagina's binnen de Microsoft Cloud for Sustainability API-bestand.
  • inzender : Kan met alle pagina's in de Microsoft Cloud for Sustainability API-portaal. Kan geen gebruikers toevoegen of verwijderen.
  • Beheerder : Alle beschikbare rechten, inclusief de mogelijkheid om gebruikers toe te voegen of te verwijderen.

Notitie

Medewerkers en beheerders kunnen de Microsoft 365-gegevensbron niet in- of uitschakelen, tenzij ze Exchange-beheerder, Skype voor Bedrijven-beheerder, SharePoint-beheerder, Algemene lezer of Rapportlezer zijn.

Gebruikers, groepen of apps toevoegen als beheerder:

  1. Selecteer het tabblad Machtigingen en selecteer vervolgens Gebruikers toevoegen.
  2. Gebruik het veld Zoeken om de gebruiker, applicatie of groep in Microsoft Entra ID te vinden die u wilt toevoegen.
  3. Selecteer een roltoewijzing en selecteer vervolgens Opslaan.

Exemplaren beheren

Navigeer naar het pictogram van het exemplaar Pictogram van exemplaar om een lijst te vinden met alle exemplaren, exemplaren te maken of exemplaren te verwijderen.

API-gebruik weergeven

Bekijk details over uw realtime API-gebruik.

  1. Navigeer naar het tabblad API-beheer en selecteer vervolgens Gebruik.
  2. Selecteer een tijdsbestek om te bekijken.

De pagina API-gebruik bevat drie secties:

  • API-aanroepen : Een grafiek die het totale aantal API-aanroepen in de geselecteerde tijdsbestek visualiseert.
  • Gegevensoverdracht : Een grafiek die de hoeveelheid gegevens weergeeft die via de API is overgedragen in de geselecteerde tijdsbestek.
  • Operaties : Een tabel met rijen voor elke beschikbare API-bewerking en details over het gebruik van de bewerkingen.

Veelgestelde vragen

Hoe berekent Microsoft de CO2-uitstoot in de cloud die beschikbaar wordt gesteld door de API?

Ga voor informatie over de berekeningsmethodologie van Microsoft naar Microsoft Cloud for Sustainability API-berekeningsmethodologie.

Waar vind ik meer informatie over het schrijven van query's met OData?

Ga voor meer informatie over OData naar Overzicht van queryopties.

Waar worden de gegevens opgeslagen die worden gebruikt om dit rapport te maken?

De gegevens worden opgeslagen in de Verenigde Staten.

Waarom kan ik de uitstootgegevens van de vorige maand niet zien?

Uitstootgegevens voor een bepaalde maand zijn beschikbaar op de 14e dag na het einde van die maand (inclusief niet-werkdagen).

Ik kan geen exemplaar maken. Waarom?

Mogelijk probeert u toegang te krijgen tot de Cloud for Sustainability API-portal met een account dat is gekoppeld aan een andere hosttenant-id dan de id die u op het onboardingformulier hebt opgegeven. Deze situatie kan zich voordoen wanneer u een gastaccount gebruikt. Gastaccounts worden niet ondersteund. Als u wilt dat wij een andere tenant onboarden, dient u het onboarding-formulier opnieuw in.

Ik heb een andere tenant-id voor Microsoft 365 en Azure. Kan ik de Microsoft Cloud for Sustainability-API nog gebruiken?

U hebt nog steeds toegang tot de API's, maar de portal biedt geen ondersteuning voor meerdere tenants per exemplaar. U moet deze tenants afzonderlijk onboarden bij de API's.

Hoe configureer ik een app om de Microsoft Cloud for Sustainability-API aan te roepen?

Geïnteresseerd in het configureren van een app om de API van Cloud for Sustainability aan te roepen? Deze demo bekijken:

Ga in de Azure-portal naar uw Microsoft Entra ID, selecteer App-registraties en selecteer vervolgens + Nieuwe registratie. Geef op de nieuwe registratiepagina een naam op voor uw app-registratie, pas de opties aan uw behoeften aan en selecteer vervolgens Registreren. Ga naar de Microsoft Entra ID-pagina, selecteer het tabblad Ondernemingstoepassingen, stel Toepassingstype in op Microsoft-toepassingen en zoek de toepassingsnaam MCFS SDS. De ApplicationId-parameter die u hebt doorgegeven in de opdracht New-AzADServicePrincipal en die vereist is tijdens het onboarden, is de ApplicationId van de Microsoft Cloud for Sustainability API (00001111-aaaa-2222-bbbb-3333cccc4444) waarmee u een instantie (bedrijfstoepassing) van de Microsoft Cloud for Sustainability API-appregistratie in uw eigen tenant hebt gemaakt.

Vervolgens kunt u nu naar uw app-registratiepagina gaan en het tabblad API-machtigingen selecteren. U kunt een machtiging voor uw app-registratie toevoegen om de Microsoft Cloud for Sustainability-API aan te roepen door +Een machtiging toevoegen te selecteren, gevolgd door de optie API's die mijn organisatie gebruikt. Zoek vervolgens naar de ApplicationId van de Microsoft Cloud for Sustainability API (00001111-aaaa-2222-bbbb-3333cccc4444), selecteer MCFS SDS en selecteer vervolgens de App.Emissions.Read machtiging van het blad Application permissions .

Deze machtiging voor het toepassingstype moet beheerderstoestemming krijgen door Beheerderstoestemming verlenen voor {your-tenant} te selecteren.

Bezoek tot slot de Microsoft Cloud for Sustainability-API-startpagina, navigeer naar het tabblad Machtigingen en selecteer vervolgens + Toevoegen. Kies in het zijpaneel dat verschijnt de optie Kijker als de rol in de invoer Gebruiker, Groep of Toepassing en ga verder met zoeken naar uw toepassingsregistratie. Selecteer Opslaan.

Ik verkrijg een toegangstoken voor mijn toepassing, wat is de resource-URL?

00001111-aaaa-2222-bbbb-3333cccc4444/.default

Hoeveel historische gegevens zijn er beschikbaar?

  • Azure: De gegevens over gebruik en emissies hebben betrekking op de laatste vijf jaar aan gegevens die verband houden met de inschrijving.
  • Microsoft 365: De emissiegegevens hebben betrekking op de laatste 12 maanden aan gegevens die verband houden met het Microsoft 365 abonnement.

Vrijwaring

De API voor Microsoft Cloud for Sustainability (preview) is gebaseerd op industriestandaarden voor CO2-berekening van servers. De API biedt algemene schattingen om organisaties te helpen inzicht te krijgen in de CO2-uitstoot van de IT-infrastructuur die is gekoppeld aan het gebruik van Azure-cloudservices. De bevindingen, interpretaties en conclusies gepresenteerd met de Microsoft Cloud for Sustainability-API (preview), inclusief de berekeningen, zijn geen specifieke adviezen of aanbevelingen. Informatie en opinies kunnen zonder voorafgaande kennisgeving worden gewijzigd. De Microsoft Cloud for Sustainability API (preview) wordt aangeboden in de huidige vorm, zonder enige verklaring of garantie van welke aard dan ook, expliciet of impliciet, met inbegrip van maar niet beperkt tot verklaringen of goedkeuringen met betrekking tot het gebruik van, de resultaten van of de prestaties van de Microsoft Cloud for Sustainability API (preview) of de geschiktheid, nauwkeurigheid, betrouwbaarheid of juistheid hiervan. Het volledige risico met betrekking tot het gebruik van de Microsoft Cloud for Sustainability API (preview) ligt bij u. Microsoft aanvaardt geen aansprakelijkheid voor het gebruik van de API voor Microsoft Cloud for Sustainability (preview). Microsoft is in geen geval aansprakelijk voor andere directe of indirecte schade, met inbegrip van winstderving, verlies van spaarrekening of incidentele of gevolgschade die voortvloeit uit defecten of het gebruik of het niet kunnen gebruiken van de Microsoft Cloud for Sustainability API (preview), zelfs als Microsoft op de hoogte is gesteld van de mogelijkheid van dergelijke schade.

Microsoft Cloud for Sustainability API OData-queryvoorbeelden
Microsoft Cloud for Sustainability API-berekeningsmethodologie
Microsoft Cloud for Sustainability API

📄 productpagina
🎓 Training

✅ Gratis proef
🎥 YouTube kanaal

💻 Community
LinkedIn-pictogram.LinkedIn groep