Поділитися через

Cloud for Sustainability API (підготовча версія) Приклади запитів OData

  • Стаття

Безкоштовна пробна версія

Важливо

Деякі або всі ці функції доступні в підготовчому версії. Вміст і функції можуть змінитися.

Open Data Protocol (OData) – це протокол доступу до даних, побудований на основі основних протоколів, таких як HTTP. Він використовує загальноприйняті методології, такі як REST для Інтернету. Ви можете використовувати різні бібліотеки та інструменти для використання сервісів 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 повертає максимум 1000 результатів на сторінці. Якщо доступно більше результатів, API повертає властивість an @odata.nextLink , що містить URL-адресу на наступну сторінку результатів.

Сутність EnrollmentEmission (для Azure викидів)

Представляє дані про викиди для облікового запису для виставлення рахунків, які також називають реєстрацією.

Властивість Ввести Примітки
dateKey INT32 Дата у форматі yyyymmdd ; dd завжди дорівнює 01.
Ідентифікатор зарахування рядок Також відомий як ідентифікатор облікового запису для платежів.
orgName рядок Те саме, що ім’я ТП або ім’я верхнього батьківського елемента.
ідентифікатор підписки рядок ID абонемента.
subscriptionName рядок Назва передплати.
azureServiceName рядок Назва служби Azure, наприклад, App Service
Підсервіс рядок Наприклад, Azure Storage або Azure Compute.
azureRegionName рядок Azure регіон, де розгорнуто сервіс.
область рядок Сфера застосування парникових газів, наприклад, сфера 1, сфера 2 або сфера 3.
scopeId INT32 ID області видимості.
totalEmissions подвійне значення Загальний обсяг викидів за рекорд (mtCO2e).

Приклади запитів для сутності EnrollmentEmission (для Azure emissions)

Тип запиту Приклад
Викиди за зарахуванням {serviceRootAzure}/Викидів
Виберіть певні поля {serviceRootAzure}/emissions?$select=enrollmentId,totalEmissions,scopeId
Включіть кількість {serviceRootAzure}/викиди?$count=правда
Обмежити кількість результатів {serviceRootAzure}/викидів?$top=100
Довантаження {serviceRootAzure}/викидів?$skip=100&$top=50
Фільтр за сферою застосування {serviceRootAzure}/emissions?$filter=ScopeId eq 1
Фільтр і агрегат {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count як Count, totalEmissions з середнім значенням як середнім, totalEmissions з сумою як сумою)
Фільтр і група {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0.05)/groupby(((ScopeId), aggregate($count як кількість))’

Microsoft365Emission entity (для Microsoft 365 емісій)

Відображає Microsoft 365 викиди центрів обробки даних, пов’язані з наступними застосуваннями:

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Excel
  • PowerPoint
  • Програма Outlook
Властивість Ввести Примітки
dateKey INT32 Дата у форматі yyyymmdd ; dd завжди дорівнює 01.
tenantId рядок Посвідчення особи орендаря.
tenantName рядок ПІБ орендаря.
officeRegionName рядок Microsoft 365 регіон дата-центру.
область рядок Сфера застосування парникових газів, наприклад, сфера 1, сфера 2 або сфера 3.
totalEmissions подвійне значення Загальний обсяг викидів за рекорд (mtCO2e).

Приклади запитів для сутності Microsoft 365Emission (для Microsoft 365 викидів)

Тип запиту Приклад
Викиди для орендаря {serviceRootM365}/Орендарі
Виберіть певні поля {serviceRootM365}/викиди?$select=tenantId,totalEmissions,scope
Включіть кількість {serviceRootM365}/tenantemissions?$count=true
Обмежити кількість результатів {serviceRootM365}/орендарів?$top=100
Довантаження {serviceRootM365}/орендарів?$skip=100&$top=50
Фільтр за сферою застосування {serviceRootM365}/tenantemissions?$filter=Scope eq ’FILLMEIN’
Фільтр і агрегат {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq ’FILLMEIN’)/aggregate($count як Count, totalEmissions з average як Average, totalEmissions з sum як Sum)
Фільтр і група {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0.05)/groupby(((Scope), aggregate($count as Count))’

Сутність EnrollmentUsage (для викидів Azure)

Являє собою розрахований коефіцієнт використання Microsoft хмарних ресурсів.

Властивість Ввести Примітки
dateKey INT32 Дата у форматі yyyymmdd ; dd завжди дорівнює 01.
Ідентифікатор зарахування рядок Також відомий як ідентифікатор облікового запису для платежів.
orgName рядок Те саме, що ім’я ТП або ім’я верхнього батьківського елемента.
ідентифікатор підписки рядок ID абонемента.
subscriptionName рядок Назва передплати.
Підсервіс рядок Наприклад, Azure Storage або Azure Compute.
azureRegionName рядок Azure регіон, де розгорнуто сервіс.
використання подвійне значення Загальне використання запису. Не має цієї одиниці, оскільки вона відображає нормалізоване використання послуги в вказаному регіоні.

Для отримання додаткової інформації про методологію розрахунку Microsoft перейдіть до Microsoft Cloud for Sustainability розділу Методологія розрахунку API.|

Приклади запитів для сутності EnrollmentUsage

Тип запиту Приклад Нотатка
Усі дані про використання {serviceRootAzure}/використання
Загальне використання по місяцях на підписку {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(використання з сумою як TotalUsage))&$orderby=SubscriptionName,DateKey

сутність EnrollmentProjection (для викидів Azure)

Відображає прогнозовані викиди на решту календарного року на основі ковзного середнього за попередні п’ять місяців. Призначено для щорічних візуалізацій.

Властивість Ввести Примітки
dateKey INT32 Дата у форматі yyyymmdd ; dd завжди дорівнює 01.
Ідентифікатор зарахування рядок Також відомий як ідентифікатор облікового запису для платежів.
Фактичні викиди подвійне значення Включено лише для минулих дат (mtCO2e).
прогнозованих викидів подвійне значення На основі ковзного середнього за попередні п’ять місяців або менше на основі фактичних даних, доступних за поточний рік (mtCO2e).
Фактичне використання подвійне значення Включено лише для минулих дат.
projectedВикористання подвійне значення На основі ковзного середнього за попередні п’ять місяців або менше на основі фактичних даних, доступних за поточний рік.

Приклади запитів для сутності EnrollmentProjection (для викидів Azure)

Тип запиту Приклад Нотатка
Прогнози на 7-2022 рік {serviceRootAzure}/projections?$filter=dateKey gt 20220701
Всі прогнози на рік {serviceRootAzure}/Прогнози

Важливо

Наразі Microsoft Cloud for Sustainability API знаходиться в підготовчі версії і може бути змінено. Ваші історичні показники викидів також можуть бути оновлені, оскільки Microsoft покращує точність і повноту даних.

Поширені запитання

Як Microsoft розраховує викиди та використання?

Щоб отримати інформацію про методологію розрахунку Microsoft, перейдіть до Microsoft Cloud for Sustainability методології розрахунку API.

Що таке Rownum?

API використовує rownum для послідовної нумерації сторінок. Значення може змінюватися, тому ваш додаток не повинен залежати від нього.

Що таке ідентифікатор зарахування?

Ідентифікатор зарахування – це ідентифікатор облікового запису для виставлення рахунків. Знайдіть свій ідентифікатор реєстрації та ідентифікатор облікового запису для виставлення рахунків на порталі Azure.

Як отримати токен авторизації для мого цільового середовища?

Для роботи API потрібен OAuth токен авторизації. Ми рекомендуємо використовувати# Microsoft Authentication Library (MSAL).

API повертає властивість, @odata.nextLink якщо результатів більше, ніж повернуто в поточній відповіді. Ваш додаток повинен виконати ще один GET на цьому наступному посиланні, щоб отримати наступну сторінку результатів. Остання сторінка не містить nextLink. Вивчіть цей зразок коду, щоб дізнатися більше про нумерацію сторінок за допомогою бібліотеки клієнт OData.

📄 Сторінка
🎓 продукту Навчання

✅ Безкоштовний пробний
🎥 YouTube канал

💻 Спільнота
Піктограма LinkedIn.LinkedIn група