Reservations Summaries - List By Reservation Order And Reservation

Служба:: Consumption

Версия API:: 2024-08-01

Выводит сводки резервирования для ежедневного или ежемесячного зерна. Примечание. Arm имеет ограничение на полезные данные в 12 МБ, поэтому вызывающие в настоящее время получают 400, когда размер отклика превышает ограничение ARM. В таких случаях вызов API должен выполняться с меньшими диапазонами дат.

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain={grain}

С использованием необязательных параметров:

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain={grain}&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
reservationId	path	True	string	Идентификатор резервирования
reservationOrderId	path	True	string	Идентификатор заказа резервирования
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
grain	query	True	Datagrain	Может быть ежедневно или ежемесячно
$filter	query		string	Требуется только для ежедневного зерна. Свойства/UsageDate для даты начала и даты окончания. Фильтр поддерживает "le" и "ge"

Ответы

Имя	Тип	Описание
200 OK	ReservationSummariesListResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "properties": {
        "avgUtilizationPercentage": 0,
        "kind": "Reservation",
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 0,
        "skuName": "Standard_D8s_v3",
        "totalReservedQuantity": 155,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      },
      "tags": {
        "dev": "tools",
        "env": "newcrp"
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "properties": {
        "avgUtilizationPercentage": 0,
        "kind": "Reservation",
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 0,
        "skuName": "Standard_D8s_v3",
        "totalReservedQuantity": 155,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      },
      "tags": {
        "dev": "tools",
        "env": "newcrp"
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
Datagrain
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ReservationSummariesListResult	Результат перечисления сводок резервирования.
ReservationSummary	ресурс сводки резервирования.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

Datagrain

Перечисление

Значение	Описание
daily	Ежедневное количество данных
monthly	Ежемесячное количество данных

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ReservationSummariesListResult

Object

Результат перечисления сводок резервирования.

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	ReservationSummary[]	Список сводок резервирования.

ReservationSummary

Object

ресурс сводки резервирования.

Имя	Тип	Описание
etag	string	Etag для ресурса.
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.avgUtilizationPercentage	number (decimal)	Это среднее использование для всего диапазона времени. (день или месяц в зависимости от зерна)
properties.kind	string	Тип резервирования.
properties.maxUtilizationPercentage	number (decimal)	Это максимальное почасовое использование в период использования (день или месяц). Например, если запись об использовании соответствует 12.10.2017 и в течение часа 4 и 5, использование составило 100%, это поле вернет 100% в течение этого дня.
properties.minUtilizationPercentage	number (decimal)	Это минимальное почасовое использование в течение времени использования (день или месяц). Например, если запись об использовании соответствует 12.10.2017 и в течение часа 4 и 5, использование было 10%, это поле вернет 10% в течение этого дня.
properties.purchasedQuantity	number (decimal)	Это приобретенное количество для идентификатора резервирования.
properties.remainingQuantity	number (decimal)	Это оставшееся количество для идентификатора резервирования.
properties.reservationId	string	Идентификатор резервирования — это идентификатор резервирования в порядке резервирования. Каждое резервирование — это группирование для применения области преимущества, а также указывает количество экземпляров, к которым можно применить преимущество резервирования.
properties.reservationOrderId	string	Идентификатор заказа на резервирование — это идентификатор покупки резервирования. Каждый идентификатор заказа на резервирование представляет одну транзакцию покупки. Заказ на резервирование содержит резервирования. Порядок резервирования определяет размер виртуальной машины и регион резервирования.
properties.reservedHours	number (decimal)	Это общее время, зарезервированное. Например, если резервирование для 1 экземпляра было сделано 1 вечера, это будет 11 часов в течение этого дня и 24 часов с последующих дней
properties.skuName	string	Это имя SKU ARM. Его можно использовать для присоединения к полю serviceType в дополнительных сведениях в записях об использовании.
properties.totalReservedQuantity	number (decimal)	Это общее количество экземпляров, зарезервированных для идентификатора резервирования.
properties.usageDate	string (date-time)	Данные, соответствующие записи использования. Если количество данных является ежемесячным, оно будет первым днем месяца.
properties.usedHours	number (decimal)	Общее количество используемых часов резервирования
properties.usedQuantity	number (decimal)	Это используемое количество для идентификатора резервирования.
properties.utilizedPercentage	number (decimal)	Это процент использования для идентификатора резервирования.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

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

Reservations Summaries - List By Reservation Order And Reservation

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ReservationSummariesDailyWithReservationId

Образец запроса

Пример ответа

ReservationSummariesMonthlyWithReservationId

Образец запроса

Пример ответа

Определения

createdByType

Datagrain

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReservationSummariesListResult

ReservationSummary

systemData