Reservation Transactions - List

リファレンス

サービス:: Consumption

API バージョン:: 2024-08-01

課金アカウントスコープでの予約インスタンスのトランザクションの一覧。注: 払戻トランザクションは、購入トランザクションと共に転記されます (つまり、購入請求月)。たとえば、払い戻しは 2021 年 5 月に要求されます。この払い戻しトランザクションのイベント日は 2021 年 5 月、請求月は予約購入時の 2020 年 4 月になります。注: ARM のペイロードサイズの制限は 12 MB であるため、応答サイズが ARM の制限を超えると、現在呼び出し元は 400 を受け取ります。このような場合は、より小さな日付範囲で 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 ID
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 年 12 月全体のデータが含まれます (つまり、12 月 30 日と 31 日の日付のレコードが含まれます)。
previewMarkupPercentage	query		number (decimal)	適用するプレビューマークアップの割合。
useMarkupIfPartner	query		boolean	呼び出し元がパートナーである場合は、トランザクションにマークを適用します。

応答

名前	型	説明
200 OK	ReservationTransactionsListResult	わかりました。要求は成功しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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	エラーの詳細。