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

Огляд Cloud for Sustainability API (підготовча версія)

  • Стаття

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

Microsoft Cloud for Sustainability Tech Summit листопад 2024 року.

Важливо

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

Microsoft Cloud for Sustainability надає API для доступу до даних про викиди, пов’язаних із вашим Azure і Microsoft 365 використанням.

Точний обчислення викидів вуглецю вимагає хорошої інформації від партнерів, постачальників і постачальників. API Cloud for Sustainability забезпечує прозорість щодо викидів вуглецю, спричинених використанням Azure та Microsoft 365. обчислення викидів вуглецю Microsoft поширюється на всі три області викидів за допомогою методології, перевіреної третьою стороною. Він використовує послідовний і точний обчислення викидів вуглецю для кількісної оцінки впливу Azure і Microsoft 365 впливу клієнтів на навколишнє середовище.

Детальна інформація про API вказана в довіднику Microsoft Cloud for Sustainability API. Вони містять додаткові відомості про операції, параметри та відповіді.

Важливо

Наразі Microsoft Cloud for Sustainability API знаходиться в підготовчі версії і може бути змінено. Крім того, історичні показники викидів можуть оновлюватися, оскільки корпорація Майкрософт удосконалює точність і повноту даних. Цей підготовча версія не призначений для дотримання законодавства, маркетингу чи звітності.

Початок роботи з API Cloud for Sustainability

Нотатка

Якщо ваша організація хоче отримати доступ до Microsoft Cloud for Sustainability API (підготовча версія), надішліть цю форму реєстрації.

Почніть роботу з API, виконавши наступні процедури:

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

  • Azure: Microsoft Cloud for Sustainability API для Azure підтримують облікові записи EA Direct, MCA та MPA з прямими білінговими відносинами з Microsoft. Клієнти, які купують Azure у постачальника хмарних рішень (CSP), не отримують підтримки, і вони повинні співпрацювати безпосередньо зі своїм CSP, щоб дізнатися про свої хмарні викиди. Застарілі облікові записи, облікові записи на основі кредитів, зареєстровані в Китаї та облікові записи уряду Azure не підтримуються. Щоб перевірити тип облікового запису, перейдіть до розділу Перевірити тип облікового запису.

    Нотатка

    Використання Azure Hybrid Benefit наразі не фіксується та не відображається у викидах.

  • Microsoft 365: Microsoft Cloud for Sustainability API для Microsoft 365 підтримки бізнесу, підприємства або підписки на освіту для Microsoft 365 або Office 365. Розгортання національних/регіональних хмар, включаючи, але не обмежуючись, хмари уряду Microsoft у США та Office 365 керовані 21Vianet, не підтримуються.

Авторизуйтесь та створіть екземпляр

Отримавши доступ до Microsoft Cloud for Sustainability API від Microsoft, увійдіть за допомогою своїх облікових даних Azure Microsoft Entra ID.

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

Перегляньте це відео з оглядом використання API та порталу Cloud for Sustainability:

Налаштуйте джерела даних та увімкніть API

Важливо

Щоб успішно ввімкнути доступ до даних вашої організації, цей крок має виконати відповідний адміністратор. Для облікових записів Azure MCA потрібен адміністратор облікового запису для виставлення рахунків із роллю читача, співавтора або власника облікового запису для виставлення рахунків. Для облікових записів Azure EA потрібен адміністратор підприємства або адміністратор підприємства – лише для читання. Перевірте свою роль на порталі Azure. Для Microsoft 365 цього потрібна одна з таких ролей: адміністратор Exchange, адміністратор Skype для бізнесу, SharePoint адміністратор, глобальний читач, читач звітів. Azure та Microsoft 365 адміністратори можуть створювати інсталяції або додавати до інсталяцій, щоб увімкнути джерела даних і API. Якщо у вас немає обов’язкової ролі адміністратора для ввімкнення даних, ви можете досліджувати API лише за допомогою демонстраційних даних.

  1. На вкладці «Джерела даних» увімкніть підключення , щоб підключити Azure або Microsoft 365 дані про викиди. Переконайтеся, що статус вказано як Доступний , перш ніж використовувати API. Ця дія активує дані про викиди, пов’язані з усіма зареєстрованими або платіжними обліковими записами, до яких у вас є доступ. Якщо у вас немає доступу до даних про викиди, використовуйте лише демонстраційні дані.

    Нотатка

    Може знадобитися до 48 годин, перш ніж Microsoft 365 дані про викиди стануть доступними після ввімкнення джерело даних. Вимкнення Microsoft 365 джерело даних призведе до остаточного видалення даних про викиди за минулі Microsoft 365 періоди.

    Джерела даних.

  2. Виберіть вкладку Керування API, а потім натисніть Увімкнути.

    Увімкнення API генерує первинний та вторинний API ключі для екземпляра для використання в запитах API. Щоб повторно згенерувати ключі, виберіть Оновіть піктограму. . Щоб скопіювати ключі, виберіть Значок копіювання. .

Зацікавлені в налаштуванні програми для виклику Cloud for Sustainability API? Перегляньте цю демонстрацію:

Спробуйте API

На вкладці «Керування API» виберіть «Спробувати API », щоб ознайомитися з API OData та «Експорт». Інтерактивно запитуйте дані про викиди, підключивши API OData з низькою затримкою до своїх інформаційних панелей. Або виконайте власну масову обробку, перенісши дані про викиди безпосередньо до ваших Azure Data Lake Storage служб за допомогою API експорту. У новій вкладці відкриється портал розробників, де ви можете досліджувати схеми запитів і відповідей, а також робити живі запити на Microsoft Cloud for Sustainability API.

Спробуйте API OData

  1. На навігаційній панелі ліворуч переконайтеся, що ввімкнено параметр «Групувати за тегом », і виберіть групування OData , щоб переглянути API Azure і Microsoft 365 OData.

  2. Щоб зробити запит у реальному часі, натисніть Спробувати. Введіть всі обов’язкові поля:

    • Авторизація: автоматично заповнений маркер авторизації
    • Ключ підписки: автоматично заповнюється ключем API на вкладці «Керування API».
    • enrollmentId: ваш ідентифікатор реєстрації, також відомий як ідентифікатор облікового запису для виставлення рахунків. Тільки Azure. Якщо у вас немає доступу до реєстрації, ви можете дослідити API за допомогою демонстраційних даних, ввівши демодані в це поле.
    • instanceId: знайдено в URL-адресі порталу Microsoft Cloud for Sustainability API
    • tenantId: Microsoft 365 ідентифікатор орендаря.

    Спробуйте на сторінці.

  3. Додайте всі необхідні параметри запиту. Прокрутіть до нижньої частини бічної панелі та виберіть Надіслати. Tвідповідь HTTP відображається в нижній частині панелі.

Перегляньте це відео, щоб дізнатися більше про API Cloud for Sustainability з OData:

Спробуйте API експорту

  1. На навігаційній панелі ліворуч переконайтеся, що ввімкнено параметр «Групувати за тегом », і виберіть групування «Експорт », щоб розпочати експорт даних про викиди та використання до озера даних. Виберіть RunExportJob.

  2. Виберіть Спробувати. Введіть усі обов’язкові поля та натисніть Надіслати.

    • Авторизація: автоматично заповнений маркер авторизації
    • Ключ підписки: автоматично заповнюється ключем API на вкладці «Керування API».
    • instanceId: знайдено в URL-адресі порталу Microsoft Cloud for Sustainability API
    • exportJobType: виберіть Azure або Microsoft 365 щоб визначити джерело даних для експорту даних про викиди та використання.
    • demodata: введіть "true", якщо ви хочете дослідити цю функціональність шляхом експорту демонстраційних даних.

  3. Вибравши Надіслати, прокрутіть униз, щоб побачити відповідь HTTP. Якщо ви експортуєте дані Azure, у відповіді відображаються ідентифікатори реєстрації для експортованих даних. Якщо у вас немає доступу до Azure або Microsoft 365 даних, ця операція не буде успішною. Переконайтеся, що ви правильно налаштували джерела даних.

    Спочатку відповідь вказує на те, що робота NotStarted . Завдання з експорту займає 2-3 хвилини, і ви можете використовувати jobID для перевірки статусу експорту за допомогою API ExportJobStatus . Переконайтеся, що завдання виконано успішно, що вказує на те, що експортовані дані тепер доступні в індексному сховищі BLOB.

    Ви можете використовувати LatestExportJob для перегляду інформації про ваше останнє завдання з експорту.

    Ви можете використовувати ExportJobs API для перегляду інформації про ваші історичні експорти.

  4. Використовуйте API ExportLocation , щоб отримати URL-адресу SAS. Термін дії URL-адреси SAS закінчується через годину. Скопіюйте URL-адресу SAS, щоб отримати доступ до експортованих даних із проміжного сховища BLOB.

  5. Термін дії даних закінчується через 28 днів після виконання завдання експорту, і їх потрібно скопіювати до завершення терміну дії. В іншому випадку дані видаляються з місця підготовки. Користувачі можуть у будь-який момент повторно запустити завдання з експорту, щоб отримати ще одну порцію даних із терміном дії 28 днів і включно з найновішим набором даних. Існує кілька способів отримати доступ до експортованих даних.

    1. Azure Storage Explorer

      Інсталюйте та відкрийте Azure Storage Explorer. Виберіть кнопку «Відкрити діалогове вікно підключення», а потім виберіть контейнер або каталог ADLS Gen2. Виберіть URL-адресу підпису спільного доступу (SAS) і вставте URL-адресу SAS із кроку 4 у контейнер Blob або каталог SAS URL-адреси . Натисніть Далі , а потім виберіть Підключитися. Вам потрібно знайти або створити контейнер у новому або наявному обліковому записі сховища, щоб використовувати його для зберігання цих експортованих даних. Скопіюйте Azure або Microsoft 365 дані зі сховища проміжного BLOB-оба та вставте їх у вибраний вами контейнер.

    2. Використовуйте azcopy. Використовуючи URL-адресу SAS з крок 4 та URL-адресу облікового запису сховища, де ви зберігаєте експортовані викиди (URL місце призначення), запустіть команду azcopy.exe:

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

    3. Сценарій Spark

      Використовуйте mssparkutils in Microsoft Fabric або Synapse. Ви можете використовувати альтернативні бібліотеки та середовища.

      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)

Приклади запитів

Щоб переглянути короткий список зразків запитів OData для роботи з API, перейдіть до прикладів запитів OData.

Призначення дозволів

Доступ до Microsoft Cloud for Sustainability API обмежений користувачами у вашій організації, яких адміністратор екземпляра додає до програми. Користувачем може бути один користувач, група або програма. Облікові записи гостей не підтримуються. Є три типи ролей, які можна призначити:

  • Переглядач: може переглядати всі сторінки в Microsoft Cloud for Sustainability API.
  • Contributor: Може взаємодіяти з усіма сторінками на порталі Microsoft Cloud for Sustainability API. Не вдається додавати або видаляти користувачів.
  • Admin: доступні всі дозволи, включно з можливістю додавати або видаляти користувачів.

Нотатка

Автори та адміністратори не можуть вимкнути або ввімкнути Microsoft 365 джерело даних, якщо вони не є адміністратором Exchange, адміністратором SharePoint Skype для бізнесу, адміністратором, глобальним читачем або читачем звітів.

Щоб додати користувачів, групи або додатки як адміністратори:

  1. Виберіть вкладку Дозволи, а потім виберіть Додати користувачів.
  2. У полі «Пошук » знайдіть Microsoft Entra ідентифікатор користувача, програму або групу, яку потрібно додати.
  3. Виберіть призначення ролі, а потім натисніть кнопку Зберегти.

Керування екземплярами

Перейдіть до піктограми екземпляр піктограма екземпляра, щоб знайти список усіх екземплярів, створити екземпляри або видалити екземпляри.

Переглянути використання API

Переглядайте детальну інформацію про використання API в реальному часі.

  1. Перейдіть на вкладку Керування API, а потім виберіть Використання.
  2. Виберіть часовий проміжок для перегляду.

Сторінка використання API містить три розділи:

  • Виклики API: діаграма, яка візуалізує агреговану кількість звернень до API за вибраний проміжок часу.
  • Передача даних: діаграма, яка показує обсяг даних, які були передані через API за вибраний проміжок часу.
  • Операції: таблиця з рядками для кожної доступної операції API та детальною інформацією про використання операцій.

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

Як корпорація Майкрософт розраховує викиди вуглецю в хмарі, доступні за допомогою API?

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

Де я можу дізнатися більше про написання запитів за допомогою OData?

Щоб дізнатися більше про OData, перейдіть до огляду параметрів запиту.

Де зберігаються дані, що використовуються для створення цього звіту?

Дані зберігаються в Сполучених Штатах.

Чому я не бачу дані про викиди за попередній місяць?

Дані про викиди за певний місяць будуть доступні до 14-го дня після закінчення цього місяця (включно з неробочими днями).

Я не можу створити екземпляр. Чому?

Можливо, ви намагаєтеся отримати доступ до API-порталу Cloud for Sustainability за допомогою облікового запису, пов’язаного з ідентифікатором клієнта хоста, відмінним від того, що вказано у формі реєстрації. Така ситуація може виникнути, коли ви користуєтеся гостьовим обліковим записом. Облікові записи гостей не підтримуються. Якщо ви хочете, щоб ми прийняли на борт іншого орендаря, повторно надішліть форму реєстрації.

У мене інший ідентифікатор клієнта для Microsoft 365 та Azure. Чи можу я використовувати Microsoft Cloud for Sustainability API?

Ви все ще можете отримати доступ до API, але портал не підтримує кілька екземплярів. Вам потрібно адаптувати цих орендарів до API окремо.

Як налаштувати програму для виклику Microsoft Cloud for Sustainability API?

Зацікавлені в налаштуванні програми для виклику Cloud for Sustainability API? Перегляньте цю демонстрацію:

На порталі Azure перейдіть до свого ідентифікатора Microsoft Entra , виберіть Реєстрація програм,а потім увімкніть + Нова реєстрація . На новій сторінці реєстрації дайте назву для реєстрації програми, налаштуйте параметри відповідно до своїх потреб, а потім натисніть Зареєструватися. Перейдіть на сторінку ідентифікатора Microsoft Entra , виберіть блейд корпоративних програм, встановіть тип програми як Microsoft Applications і виконайте пошук за назвою програми MCFS SDS. Параметр ApplicationId, який ви передали в команді New-AzADServicePrincipal, необхідний під час реєстрації, – це ApplicationId API Microsoft Cloud for Sustainability (c3163bf1-092f-436b-b260-7ade5973e5b9), за допомогою якого ви створили екземпляр (корпоративний Microsoft Cloud for Sustainability додаток) реєстрації програми API у вашому власному клієнті.

Маючи це на місці, ви тепер можете перейти на сторінку реєстрації програми та вибрати блейд дозволів API. Щоб додати дозвіл на реєстрацію додатка для виклику Microsoft Cloud for Sustainability API, виберіть + Додати дозвіл, а потім опцію API , які використовує моя організація. Потім виконайте пошук за ідентифікатором ApplicationId API Microsoft Cloud for Sustainability (c3163bf1-092f-436b-b260-7ade5973e5b9), виберіть MCFS SDS, а потім виберіть дозвіл App.Emissions.Read на використання блейда дозволів програми.

Для отримання дозволу цього типу програми потрібно надати згоду адміністратора, вибравши пункт Надати згоду адміністратора для {your-tenant}.

Нарешті, відвідайте Microsoft Cloud for Sustainability домашню сторінку API, перейдіть до блейда дозволів , а потім виберіть + Додати. На бічній панелі, що з’явиться, виберіть «Переглядач » як роль у вхідних даних для користувача, групи або програми та перейдіть до пошуку реєстрації програми. Виберіть Зберегти.

Я отримую токен доступу для своєї програми, яка URL-адреса ресурсу?

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

Скільки історичних даних доступно?

  • Azure: дані про використання та викиди охоплюють дані за останні п’ять років, пов’язаних із реєстрацією.
  • Microsoft 365Дані про викиди охоплюють дані за останні 12 місяців, пов’язані з підпискою Microsoft 365 .

Застереження

Microsoft Cloud for Sustainability API (підготовча версія) базується на галузевих стандартах для розрахунку викидів вуглецю серверів. У ньому наведено загальні оцінки, які допомагають організаціям отримати уявлення про викиди вуглецю в IT-інфраструктурі, пов’язані з використанням хмарних служб Azure. Знахідки, інтерпретації та висновки, представлені за Microsoft Cloud for Sustainability допомогою API (підготовча версія), включаючи розрахунки, не є конкретними порадами чи рекомендаціями. Висловлена інформація та висловлені погляди можуть змінюватися без попередження. Microsoft Cloud for Sustainability API (підготовча версія) надається як є, без будь-яких заяв або гарантій будь-якого роду, явних або неявних, включаючи, без обмежень, будь-які заяви або схвалення щодо використання, результатів або продуктивності Microsoft Cloud for Sustainability API (підготовча версія), його відповідності, точності, надійності або правильності. Весь ризик щодо використання Microsoft Cloud for Sustainability API (підготовча версія) берете на себе. Корпорація Майкрософт не несе відповідальності за використання Microsoft Cloud for Sustainability API (підготовча версія). За жодних обставин корпорація Майкрософт не несе відповідальності за інші прямі чи непрямі збитки, зокрема втрачену вигоду, втрачені заощадження або будь-які випадкові чи непрямі збитки, що виникли внаслідок будь-яких дефектів або використання або неможливості використання Microsoft Cloud for Sustainability API (підготовча версія), навіть якщо корпорацію Майкрософт було попереджено про можливість таких збитків.

Microsoft Cloud for Sustainability API Приклади
Microsoft Cloud for Sustainability запитів OData Методологія
Microsoft Cloud for Sustainability розрахунку API

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

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

💻 Група спільноти
Іконка LinkedIn.в LinkedIn