Reservation Transactions - List

Ссылка

Служба:: Consumption

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

Список транзакций по зарезервированным экземплярам в рамках области учетной записи выставления счетов. Примечание. Транзакции возврата размещаются вместе с его транзакцией покупки (т. е. в месяц выставления счетов за покупку). Например, возврат средств запрашивается в мае 2021 года. Эта транзакция возврата будет иметь дату события в мае 2021 года, но месяц выставления счетов по состоянию на апрель 2020 года при покупке резервирования. Примечание. Arm имеет ограничение на полезные данные в 12 МБ, поэтому вызывающие в настоящее время получают 400, когда размер отклика превышает ограничение ARM. В таких случаях вызов API должен выполняться с меньшими диапазонами дат.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01

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

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2024-08-01&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountId	path	True	string	Идентификатор BillingAccount
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2023-03-01.
$filter	query		string	Фильтрация транзакций резервирования по диапазону дат. Свойства/EventDate для даты начала и даты окончания. Фильтр поддерживает le и ge. Примечание. API возвращает данные для всего месяца выставления счетов даты начала и окончания. Например, фильтрация свойств/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 будет включать данные за весь декабрь 2020 г. (т. е. будут содержать записи для дат 30 декабря и 31)
previewMarkupPercentage	query		number (decimal)	Процент применения предварительной разметки.
useMarkupIfPartner	query		boolean	Применяет разметку к транзакциям, если вызывающий является партнером.

Ответы

Имя	Тип	Описание
200 OK	ReservationTransactionsListResult	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ReservationTransactionsByEnrollmentNumber

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

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationTransactions?$filter=properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30&api-version=2024-08-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5

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

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

{
  "value": [
    {
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "tags": [],
      "properties": {
        "eventDate": "2019-09-09T19:19:04Z",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "description": "Standard_DS1_v2 westus 1 Year",
        "eventType": "Refund",
        "quantity": 1,
        "amount": -21,
        "currency": "USD",
        "reservationOrderName": "Transaction-DS1_v2",
        "purchasingEnrollment": "123456",
        "armSkuName": "Standard_DS1_v2",
        "term": "P1Y",
        "region": "westus",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "departmentName": "Unassigned",
        "costCenter": "",
        "currentEnrollment": "123456",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "monetaryCommitment": 523123.9,
        "overage": 23234.49
      }
    },
    {
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "tags": [],
      "properties": {
        "eventDate": "2019-09-09T19:19:04Z",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "description": "Standard_DS1_v2 westus 1 Year",
        "eventType": "Purchase",
        "quantity": 1,
        "amount": 21,
        "currency": "USD",
        "reservationOrderName": "Transaction-DS1_v2",
        "purchasingEnrollment": "123456",
        "armSkuName": "Standard_DS1_v2",
        "term": "P1Y",
        "region": "westus",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "departmentName": "Unassigned",
        "costCenter": "",
        "currentEnrollment": "123456",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "monetaryCommitment": 523123.9,
        "overage": 23234.49
      }
    }
  ]
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After. Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.
ReservationTransaction	Ресурс транзакции резервирования.
ReservationTransactionsListResult	Результат перечисления рекомендаций по резервированию.

ErrorDetails

Object

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.