Reservation Transactions - List

Ссылка

Service:: Consumption

API Version:: 2023-05-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=2023-05-01

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 01.03.2023.
$filter	query		string	Фильтрация транзакций резервирования по диапазону дат. Свойства /EventDate для даты начала и даты окончания. Фильтр поддерживает "le" и "ge". Примечание. API возвращает данные для всей даты начала и даты окончания месяца выставления счетов. Например, фильтр properties/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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

ReservationTransactionsByEnrollmentNumber

Sample Request

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=2023-05-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Sample Response

Status code:: 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.
ReservationTransaction	Ресурс транзакции резервирования.
ReservationTransactionsListResult	Результат перечисления рекомендаций по резервированию.

ErrorDetails

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

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

ErrorResponse

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

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

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

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