Παραδείγματα ερωτημάτων OData για το Cloud for Sustainability API (έκδοση προεπισκόπησης)
Σημαντικό
Ορισμένες ή όλες οι λειτουργίες είναι διαθέσιμες ως μέρος μιας έκδοσης προεπισκόπησης. Το περιεχόμενο και η λειτουργικότητα υπόκεινται σε αλλαγές.
Το Πρωτόκολλο ανοιχτών δεδομένων (OData) είναι ένα πρωτόκολλο πρόσβασης σε δεδομένα, το οποίο είναι ενσωματωμένο σε κύρια πρωτόκολλα, όπως το HTTP. Χρησιμοποιεί συχνά αποδεκτές μεθοδολογίες όπως το REST για το web. Μπορείτε να χρησιμοποιήσετε διάφορες βιβλιοθήκες και εργαλεία για την κατανάλωση των υπηρεσιών OData.
Για να δημιουργήσετε τις δικές σας υλοποιήσεις με βάσει το Microsoft Cloud for Sustainability API, μπορείτε να δείτε ορισμένα από αυτά τα συχνά ζητούμενα παραδείγματα ερωτημάτων.
Τροποποιήστε τα δείγματα ερωτημάτων για να λειτουργούν στα περιβάλλοντα προορισμού:
{serviceRoot}:
https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}{instanceId}: Το GUID του περιβάλλοντος Cloud for Sustainability στο οποίο θέλετε να υποβάλετε ερώτημα, όπως 20aec369-f1c8-4814-a89d-4d449dd7e8a1.
{serviceRootM365}:
{serviceRoot}/m365{serviceRootAzure}:
{serviceRoot}/enrollments/{enrollmentId}{enrollmentId}: Το αναγνωριστικό εγγραφής, γνωστό και ως αναγνωριστικό λογαριασμού χρέωσης. Παράδειγμα: 12345678.
{tenantId}: Microsoft 365 αναγνωριστικό μισθωτή.
Σημείωμα
Ορισμένα ερωτήματα API θα περιέχουν πολλά αποτελέσματα και θα χωρίζονται σε πολλές σελίδες. Το API επιστρέφει το πολύ έως 1.000 αποτελέσματα ανά σελίδα. Εάν υπάρχουν περισσότερα αποτελέσματα, το API επιστρέφει μια ιδιότητα @odata.nextLink που περιέχει μια διεύθυνση URL στην επόμενη σελίδα αποτελεσμάτων.
Οντότητα EnrollmentEmission (για εκπομπές Azure)
Αντιπροσωπεύει τα δεδομένα υποστήριξης για έναν λογαριασμό χρέωσης, που ονομάζεται επίσης εγγραφή.
| Ιδιότητα | Type | Σημειώσεις |
|---|---|---|
| dateKey | int32 | Ημερομηνία σε μορφή yyyymmdd, το dd είναι πάντα 01. |
| enrollmentId | συμβολοσειρά | Γνωστό επίσης και ως αναγνωριστικό λογαριασμού χρέωσης. |
| orgName | συμβολοσειρά | Ίδιο με το όνομα TP ή το επάνω γονικό όνομα. |
| subscriptionId | συμβολοσειρά | Αναγνωριστικό της συνδρομής. |
| subscriptionName | συμβολοσειρά | Όνομα της συνδρομής. |
| azureServiceName | string | Όνομα μιας υπηρεσίας Azure, για παράδειγμα, Υπηρεσία εφαρμογής. |
| subService | string | Για παράδειγμα, Υπηρεσία αποθήκευσης Azure ή Υπολογιστική λειτουργία του Azure. |
| azureRegionName | συμβολοσειρά | Περιοχή Azure όπου αναπτύσσεται η υπηρεσία. |
| πεδίο | συμβολοσειρά | Πεδίο των αερίων θερμοκηπίου, για παράδειγμα, πεδίο 1, πεδίο 2 ή πεδίο 3. |
| scopeId | int32 | Αναγνωριστικό του πεδίου. |
| totalEmissions | διπλής ακρίβειας | Συνολικές εκπομπές για την καρτέλα (mtCO2e). |
Ερωτήματα-δείγματα για την οντότητα EnrollmentEmission (για εκπομπές Azure)
| Τύπος ερωτήματος | Παράδειγμα |
|---|---|
| Εκπομπές κατά εγγραφή | {serviceRootAzure}/Εκπομπές |
| Επιλέξτε ορισμένα πεδία | {serviceRootAzure}/emissions?$select=enrollmentId,totalEmissions,scopeId |
| Συμπερίληψη πλήθους | {serviceRootAzure}/εκπομπές?$count=true |
| Όριο πλήθους αποτελεσμάτων | {serviceRootAzure}/εκπομπές?$top=100 |
| Σελιδοποίηση | {serviceRootAzure}/εκπομπές?$skip=100&$top=50 |
| Φιλτράρισμα κατά πεδίο | {serviceRootAzure}/εκπομπές?$filter=ScopeId eq 1 |
| Φιλτράρισμα και συγκέντρωμα | {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count ως πλήθος, totalEmissions με μέσο όρο ως μέσο όρο, totalEmissions με άθροισμα ως άθροισμα) |
| Φιλτράρισμα και ομάδα | {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0,05)/groupby((ScopeId), aggregate($count as Count))» |
Οντότητα Microsoft365Emission (για εκπομπές Microsoft 365)
Αντιπροσωπεύει εκπομπές κέντρου δεδομένων του Microsoft 365 που σχετίζεται με τις παρακάτω εφαρμογές:
- Exchange Online
- SharePoint
- OneDrive
- Microsoft Teams
- Word
- Excel
- PowerPoint
- Outlook
| Ιδιότητα | Type | Σημειώσεις |
|---|---|---|
| dateKey | int32 | Ημερομηνία σε μορφή yyyymmdd, το dd είναι πάντα 01. |
| tenantId | συμβολοσειρά | Αναγνωριστικό του μισθωτή. |
| tenantName | συμβολοσειρά | Όνομα του μισθωτή. |
| officeRegionName | συμβολοσειρά | Περιοχή κέντρου δεδομένων Microsoft 365. |
| πεδίο | συμβολοσειρά | Πεδίο των αερίων θερμοκηπίου, για παράδειγμα, πεδίο 1, πεδίο 2 ή πεδίο 3. |
| totalEmissions | διπλής ακρίβειας | Συνολικές εκπομπές για την καρτέλα (mtCO2e). |
Ερωτήματα-δείγματα για την οντότητα Microsoft365Emission (για εκπομπές Microsoft 365)
| Τύπος ερωτήματος | Παράδειγμα |
|---|---|
| Εκπομπές για μισθωτή | {serviceRootM365}/εκπομπές μισθωτών |
| Επιλέξτε ορισμένα πεδία | {serviceRootM365}/εκπομπές?$select=tenantId,totalEmissions,scope |
| Συμπερίληψη πλήθους | {serviceRootM365}/tenantemissions?$count=true |
| Όριο πλήθους αποτελεσμάτων | {serviceRootM365}/εκπομπές ενοικιαστών?$top=100 |
| Σελιδοποίηση | {serviceRootM365}/εκπομπές μισθωτών?$skip=100&$top=50 |
| Φιλτράρισμα κατά πεδίο | {serviceRootM365}/tenantemissions?$filter=Πεδίο εφαρμογής eq 'FILLMEIN' |
| Φιλτράρισμα και συγκέντρωμα | {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count ως Count, totalEmissions με μέσο όρο ως Average, totalEmissions με άθροισμα ως Sum) |
| Φιλτράρισμα και ομάδα | {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0,05)/groupby((Πεδίο εφαρμογής), aggregate($count ως Count))» |
Οντότητα EnrollmentUsage (για εκπομπές Azure)
Αντιπροσωπεύει έναν υπολογισμένο παράγοντα χρήσης των πόρων του Microsoft Cloud.
| Ιδιότητα | Type | Σημειώσεις |
|---|---|---|
| dateKey | int32 | Ημερομηνία σε μορφή yyyymmdd, το dd είναι πάντα 01. |
| enrollmentId | συμβολοσειρά | Γνωστό επίσης και ως αναγνωριστικό λογαριασμού χρέωσης. |
| orgName | συμβολοσειρά | Ίδιο με το όνομα TP ή το επάνω γονικό όνομα. |
| subscriptionId | συμβολοσειρά | Αναγνωριστικό της συνδρομής. |
| subscriptionName | συμβολοσειρά | Όνομα της συνδρομής. |
| subService | συμβολοσειρά | Για παράδειγμα, Υπηρεσία αποθήκευσης Azure ή Υπολογιστική λειτουργία του Azure. |
| azureRegionName | συμβολοσειρά | Περιοχή Azure όπου αναπτύσσεται η υπηρεσία. |
| χρήση | διπλής ακρίβειας | Συνολική χρήση της καρτέλας. Δεν διαθέτει τη μονάδα, επειδή αντιπροσωπεύει τη συνήθη χρήση της υπηρεσίας στην καθορισμένη περιοχή. |
Για περισσότερες πληροφορίες σχετικά με τη μεθοδολογία υπολογισμού της Microsoft, μεταβείτε στη Μεθοδολογία υπολογισμού API του Microsoft Cloud for Sustainability.|
Ερωτήματα-δείγματα για την οντότητα EnrollmentUsage
| Τύπος ερωτήματος | Παράδειγμα | Σημείωμα |
|---|---|---|
| Όλα τα δεδομένα χρήσης | {serviceRootAzure}/χρήση | |
| Συνολική χρήση ανά μήνα ανά συνδρομή | {serviceRootAzure}/usage?$apply=groupby((Όνομα_συνδρομής;DateKey);aggregate(χρήση με άθροισμα ως TotalUsage))&$orderby=Όνομα_συνδρομής;DateKey |
Οντότητα EnrollmentProjection (για εκπομπές Azure)
Αντιπροσωπεύει προβλεπόμενες εκπομπές για το υπόλοιπο του ημερολογιακού έτους, με βάση τον κυλιόμενο μέσο όρο των προηγούμενων πέντε μηνών. Προορίζεται για ετήσιες απεικονίσεις.
| Ιδιότητα | Type | Σημειώσεις |
|---|---|---|
| dateKey | int32 | Ημερομηνία σε μορφή yyyymmdd, το dd είναι πάντα 01. |
| enrollmentId | συμβολοσειρά | Γνωστό επίσης και ως αναγνωριστικό λογαριασμού χρέωσης. |
| actualEmissions | διπλής ακρίβειας | Περιλαμβάνονται μόνο για παρελθούσες ημερομηνίες (mtCO2e). |
| projectedEmissions | διπλής ακρίβειας | Με βάση τον κυλιόμενο μέσο όρο των προηγούμενων πέντε μηνών ή λιγότερο με βάση τα πραγματικά διαθέσιμα στοιχεία για το τρέχον έτος (mtCO2e). |
| actualUsage | διπλής ακρίβειας | Περιλαμβάνονται μόνο για προηγούμενες ημερομηνίες. |
| projectedUsage | διπλής ακρίβειας | Με βάση τον κυλιόμενο μέσο όρο των προηγούμενων πέντε μηνών ή λιγότερο με βάση τα πραγματικά διαθέσιμα στοιχεία για το τρέχον έτος. |
Ερωτήματα-δείγματα για την οντότητα EnrollmentProjection (για εκπομπές Azure)
| Τύπος ερωτήματος | Παράδειγμα | Σημείωμα |
|---|---|---|
| Προβολές μετά τις 7-2022 | {serviceRootAzure}/projections?$filter=dateKey gt 20220701 | |
| Όλες οι προβολές για το έτος | {serviceRootAzure}/Προβλέψεις |
Σημαντικό
Το Microsoft Cloud for Sustainability API είναι αυτήν τη στιγμή σε προεπισκόπηση και υπόκειται σε αλλαγές. Τα στοιχεία ιστορικού εκπομπών ενδέχεται επίσης να ενημερωθούν καθώς η Microsoft πραγματοποιεί βελτιώσεις στην ακρίβεια και την ολοκλήρωση των δεδομένων.
FAQ
Πώς υπολογίζει η Microsoft τις εκπομπές και τη χρήση;
Για πληροφορίες σχετικά με τη μεθοδολογία υπολογισμού της Microsoft, μεταβείτε στη Μεθοδολογία υπολογισμού API του Microsoft Cloud for Sustainability.
Τι είναι το Rownum;
Το API χρησιμοποιεί rownum για συνεπή σελιδοποίηση. Η τιμή υπόκειται σε αλλαγές, ώστε η εφαρμογή σας να μην πρέπει να έχει εξάρτηση σε αυτήν.
Τι είναι ένα αναγνωριστικό εγγραφής;
Ένα αναγνωριστικό εγγραφής αναφέρεται σε ένα αναγνωριστικό λογαριασμού χρέωσης. Βρείτε το αναγνωριστικό εγγραφής και το αναγνωριστικό λογαριασμού χρέωσης στην πύλη Azure.
Πώς μπορώ να αποκτήσω ένα διακριτικό εξουσιοδότησης για το περιβάλλον προορισμού μου;
Το API απαιτεί διακριτικό OAuth εξουσιοδότησης. Συνιστάται η χρήση της Βιβλιοθήκης ελέγχου ταυτότητας Microsoft (MSAL).
Μπορείτε να δώσετε περισσότερες πληροφορίες για το πώς να χρησιμοποιήσετε το nextLink για σελιδοποίηση;
Το API επιστρέφει μια ιδιότητα @odata.nextLink εάν υπάρχουν περισσότερα αποτελέσματα από αυτά που επιστρέφονται στην τρέχουσα απόκριση. Η εφαρμογή σας θα πρέπει να εκτελέσει ένα άλλο GET σε αυτό το nextLink για να λάβετε την επόμενη σελίδα αποτελεσμάτων. Η τελευταία σελίδα δεν περιέχει επόμενη σύνδεση.
Εξερευνήστε αυτό το δείγμα κώδικα για περισσότερες λεπτομέρειες σχετικά με τη σελιδοποίηση με μια βιβλιοθήκη υπολογιστή-πελάτη OData.
Σχετικές πληροφορίες
- Επισκόπηση API Cloud for Sustainability
- Microsoft Cloud for Sustainability Μεθοδολογία υπολογισμού API
- Microsoft Cloud for Sustainability Διεπαφή προγραμματισμού εφαρμογών
