Reservations Details - List

サービス:: Consumption

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

指定された日付範囲の予約の詳細を一覧表示します。注: ARM のペイロードサイズの制限は 12 MB であるため、応答サイズが ARM の制限を超えると、現在呼び出し元は 400 を受け取ります。データサイズが大きすぎる場合は、API がデータの準備をタイムアウトした時点で 504 が発生する可能性もあります。このような場合、API 呼び出しは、より短い日付範囲で行う必要があります。または、非同期であり、応答サイズのタイムアウトには実行されないため、予約の詳細レポートの生成 API の呼び出しを行う必要があります。

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01

省略可能なパラメーターを含む:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01&startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}

URI パラメーター

名前	/	必須	型	説明
resourceScope	path	True	string	リソースの完全修飾 Azure Resource Manager 識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	日付範囲で予約の詳細をフィルター処理します。開始日と終了日のプロパティ/UsageDate。フィルターは 'le' と 'ge' をサポートしています。課金プロファイルを使用してクエリを実行する場合は適用されません
endDate	query		string	終了日。課金プロファイルを使用してクエリを実行する場合にのみ適用されます
reservationId	query		string	予約 ID GUID。 reservationOrderId も指定されている場合にのみ有効です。特定の予約にフィルターを適用する
reservationOrderId	query		string	予約注文 ID GUID。 reservationId が指定されている場合は必須。特定の予約注文へのフィルター処理
startDate	query		string	開始日。課金プロファイルを使用してクエリを実行する場合にのみ適用されます

応答

名前	型	説明
200 OK	ReservationDetailsListResult	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "properties": {
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 48,
        "skuName": "Standard_D2s_v3",
        "totalReservedQuantity": 0,
        "usageDate": "2017-11-30T00:00:00-08:00",
        "usedHours": 0.6
      },
      "tags": null
    }
  ]
}

ReservationDetailsByBillingProfileId

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01&startDate=2019-09-01&endDate=2019-10-31

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "properties": {
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 48,
        "skuName": "Standard_D2s_v3",
        "totalReservedQuantity": 0,
        "usageDate": "2019-09-30T00:00:00-08:00",
        "usedHours": 0.6
      },
      "tags": null
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01&startDate=2019-09-01&endDate=2019-10-31&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "properties": {
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservedHours": 48,
        "skuName": "Standard_D2s_v3",
        "totalReservedQuantity": 0,
        "usageDate": "2019-09-30T00:00:00-08:00",
        "usedHours": 0.6
      },
      "tags": null
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ReservationDetail	予約の詳細リソース。
ReservationDetailsListResult	予約の詳細を一覧表示した結果。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ReservationDetail

Object

予約の詳細リソース。

名前	型	説明
etag	string	リソースの etag。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.instanceFlexibilityGroup	string	インスタンスの柔軟性グループ。
properties.instanceFlexibilityRatio	string	インスタンスの柔軟性比。
properties.instanceId	string	この識別子は、リソースの名前または完全修飾リソース ID です。
properties.kind	string	予約の種類。
properties.reservationId	string	予約 ID は、予約注文内の予約の識別子です。各予約は特典スコープを適用するためのグループであり、予約特典を適用できるインスタンスの数も指定します。
properties.reservationOrderId	string	予約注文 ID は、予約購入の識別子です。各予約注文 ID は、1 つの購入トランザクションを表します。予約注文には予約が含まれます。予約注文では、予約の VM サイズとリージョンを指定します。
properties.reservedHours	number (decimal)	これは、その日に予約された合計時間です。たとえば、1 つのインスタンスの予約が午後 1 時に行われた場合、その日は 11 時間、その後の日から 24 時間になります。
properties.skuName	string	これは ARM SKU 名です。これは、使用状況レコードの追加情報の serviceType フィールドとの結合に使用できます。
properties.totalReservedQuantity	number (decimal)	これは、reservationId 用に予約されているインスタンスの合計数です。
properties.usageDate	string (date-time)	消費が発生した日付。
properties.usedHours	number (decimal)	これは、インスタンスによって使用された合計時間です。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ReservationDetailsListResult

Object

予約の詳細を一覧表示した結果。

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
value	ReservationDetail[]	予約の詳細の一覧。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。