Переход с API сведений об использовании EA
Клиенты EA, которые ранее использовали API корпоративных отчетов за конечной точкой consumption.azure.com для получения сведений об использовании и расходов на marketplace, необходимо перейти на новые и улучшенные решения. Ниже представлены инструкции, а также все различия в контрактах между старым API и новыми решениями.
Набор данных называется сведениями о затратах вместо сведений об использовании.
Примечание.
Все API-интерфейсы отчетов Azure Enterprise не удаляются. Как можно скорее следует перейти в API управления затратами Майкрософт.
Общедоступные новые решения
В таблице ниже приведена сводка доступных назначений миграции, а также сводка по выбору подходящего решения.
| Решение | Description | Рекомендации | Сведения о подключении |
|---|---|---|---|
| Экспорты | Повторяющиеся дампы данных в хранилище по расписанию | – Наиболее масштабируемое решение для рабочих нагрузок. – Можно настроить использование секционирования файлов для больших наборов данных. – Отлично подходит для создания растущего набора данных о затратах, который можно интегрировать с собственными запрашиваемыми хранилищами данных. – Требуют доступа к учетной записи хранения, которая может содержать данные. |
- Настройка на портале Azure Автоматизация создания экспорта с помощью API - Справочник по API экспорта |
| API сведений о затратах | Загрузка по требованию | – Удобна для небольших наборов данных затрат. – Хорошо подходит для сценариев, когда экспорт в службу хранилища Azure невозможен из-за проблем, связанных с безопасностью или управляемостью. |
- Получение небольших наборов данных о затратах по запросу - API сведений о затратах |
В общем случае рекомендуем использовать Exports, если у вас есть текущие потребности в приеме данных и/или большой ежемесячный набор данных о затратах. Дополнительные сведения см. в статье Прием сведений о затратах. Если вам нужны дополнительные сведения, чтобы принять решение о рабочей нагрузке, ознакомьтесь со статьей Выбор решения для получения сведений о затратах.
Назначение разрешений имени субъекта-службы для вызова API
Если вы хотите вызвать API экспорта или сведений о затратах программным способом, необходимо настроить субъект-службу с правильным разрешением. Дополнительные сведения см. в разделе Назначение разрешений API ACM.
Не используйте Microsoft Consumption Usage Details API
Consumption Usage Details API (API сведений об использовании потребления) — это другая конечная точка, которая в настоящее время поддерживает клиентов EA. Не переходите на этот API. Перейдите на API экспорта или сведений о затратах, как описано ранее в этом документе. API сведений об использовании потребления будет устарел в будущем и находится за следующей конечной точкой.
GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?api-version=2021-10-01
Этот API является синхронной конечной точкой и не сможет масштабироваться по мере увеличения набора данных расходов и помесячного изменения стоимости. Если вы сейчас используете Consumption Usage Details API, рекомендуем как можно скорее перейти с него на API экспорта или сведений о затратах. Официальное объявление об отмене будет сделано в будущем. Дополнительные сведения о переходе c Consumption Usage Details API см. в статье Миграция из API сведений об использовании потребления.
Преимущества переноса
Наши новые решения предоставляют множество преимуществ по сравнению с API сведений об использовании отчетов EA. Ниже приведена сводная информация о вариантах.
- Безопасность и стабильность. Новые решения для доступа к данным требуют маркер субъекта-службы и (или) пользователя. Они более безопасны, чем ключи API, используемые для проверки подлинности в API отчетов EA. Ключи в этих устаревших API действительны в течение шести месяцев и их утечка может привести к раскрытию конфиденциальных финансовых данных. Кроме того, если ключи не обновляются и не интегрируются в рабочие нагрузки до истечения их шестимесячного срока действия, доступ к данным отменяется. Это нарушит рабочие нагрузки клиентов.
- Масштабируемость. API отчетов EA не рассчитаны на масштабирование при увеличении использования Azure. Набор данных об использовании может стать очень большим по мере развертывания дополнительных ресурсов в облаке. Новые решения являются асинхронными и основаны на значительно усовершенствованной инфраструктуре, чтобы обеспечить успешную загрузку набора данных любого размера.
- Единый набор данных для всех сведений об использовании— сведения об использовании Azure и Azure Marketplace были объединены в один набор данных в новых решениях. Это сокращает количество API, которые необходимо вызвать, чтобы просмотреть все расходы.
- Амортизация покупок. Клиентам, которые покупают резервирования, доступно амортизированное представление о затратах.
- Согласованность схемы. Доступные решения предоставляет файлы с соответствующими полями. Это позволяет легко переходить между решениями в зависимости от сценария использования.
- Интеграция распределения затрат — Соглашение Enterprise и Клиентское соглашение Майкрософт клиенты могут использовать новое решение для просмотра расходов в отношении настроенных правил распределения затрат. Дополнительные сведения о распределении затрат см. в статье Распределение затрат.
- Улучшения в будущем. Новые решения находятся на этапе активной разработки. Решения получают все новые функции по мере их выпуска.
API использования Enterprise, с которых нужно перейти
В следующей таблице приведены различные API, которые можно использовать сегодня для приема данных о затратах. Если вы используете один из следующих API, необходимо перейти к одному из новых решений, описанных ранее. Все API находятся за конечной https://consumption.azure.com точкой.
| Конечная точка | Комментарии API |
|---|---|
/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
– Метод API: GET – Синхронный (не опрос) – Формат данных: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01&endTime=2017-01-10 |
— метод API: GET – Синхронный (не опрос) – Формат данных: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails |
– Метод API: GET – Синхронный (не опрос) – Формат данных: JSON |
/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
– Метод API: GET – Синхронный (не опрос) – Формат данных: JSON |
/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01&endTime=2017-01-10 |
– Метод API: GET – Синхронный (не опрос) – Формат данных: JSON |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
– Метод API: POST – Асинхронный (на основе опроса) – Формат данных: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01&endTime=2017-04-10 |
– Метод API: POST – Асинхронный (на основе опроса) – Формат данных: CSV |
Сопоставление полей данных
В следующей таблице представлена сводка старых полей, доступных в решениях, которые вы используете вместе с полем для использования в новых решениях.
| Старое поле | Новое поле | Комментарии |
|---|---|---|
| accountId | ||
| accountName | AccountName | |
| accountOwnerEmail | AccountOwnerId | |
| additionalInfo | AdditionalInfo | |
| chargesBilledSeparately | isAzureCreditEligible | Свойства являются противоположными. Если isAzureCreditEnabled значение равно true, ChargesBilledSeparately будет равно false. |
| consumedQuantity | Количество | |
| consumedService | ConsumedService | |
| consumedServiceId | ConsumedService | consumedServiceId предоставляет только числовое значение.ConsumedService предоставляет имя службы. |
| стоимость | CostInBillingCurrency | |
| costCenter | CostCenter | |
| Дата | Дата | Формат в старом поле был гггг-мм-дд, а новое поле находится в формате мм/дд/гггг. |
| departmentId | InvoiceSectionId | |
| departmentName | InvoiceSectionName | |
| extendedCost | CostInBillingCurrency | |
| instanceId | ResourceId | |
| isRecurringCharge | Если применимо, используйте и Term fields перейдите Frequency вперед. |
|
| расположение | ResourceLocationNormalized | |
| meterCategory | MeterCategory | |
| meterId | MeterId | |
| meterName | MeterName | |
| meterRegion | MeterRegion | |
| meterSubCategory | MeterSubCategory | |
| offerId | OfferId | |
| orderNumber | Недоступна. | |
| partNumber | partNumber | |
| planName | PlanName | |
| продукт | НаименованиеПродукта | |
| publisherName | PublisherName | |
| resourceGroup | ResourceGroup | |
| resourceGuid | MeterId | Значения различаются. resourceGuid — это значение идентификатора GUID. meterId — это длинное число. |
| resourceLocation | Расположение ресурса | |
| resourceLocationId | Недоступна. | |
| resourceRate | EffectivePrice | |
| serviceInfo1 | ServiceInfo1 | |
| serviceInfo2 | ServiceInfo2 | |
| serviceName | MeterCategory | |
| serviceTier | MeterSubCategory | |
| storeServiceIdentifier | Недоступна. | |
| subscriptionGuid | SubscriptionId | |
| subscriptionId | SubscriptionId | |
| subscriptionName | SubscriptionName | |
| tags | Теги | Новое поле не содержит включаемых {} пар "ключ-значение". |
| unitOfMeasure | UnitOfMeasure |
Связанный контент
- Ознакомьтесь со статьей Общие сведения о переходе с API-интерфейсов отчетов EA на API Azure Resource Manager.