Reservation Recommendation Details - Get

リファレンス

Service:: Consumption

API Version:: 2023-05-01

予約インスタンスの what-if 分析に関する予約の推奨事項の詳細。

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}

With optional parameters:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}&$filter={$filter}

URI パラメーター

名前	/	必須	型	説明
resourceScope	path	True	string	予約の推奨事項の詳細操作に関連付けられているスコープ。これには、サブスクリプションスコープの場合は '/subscriptions/{subscriptionId}/'、リソースグループスコープの場合は '/subscriptions/{subscriptionId}/{resourceGroupName}'、BillingAccount スコープの場合は /providers/Microsoft.Billing/billingAccounts/{billingAccountId}'、billingProfile スコープの場合は '/providers/Microsoft.Billing/billingAccountId}/{billingProfileId}' が含まれます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2023-03-01 です。
lookBackPeriod	query	True	lookBackPeriod	予約の推奨事項の結果の基になっている期間をフィルター処理します。
product	query	True	string	予約の推奨事項の結果が生成される製品をフィルター処理します。例: Standard_DS1_v2 (VM の場合)、Premium_SSD_Managed_Disks_P30 (Managed Disksの場合)
region	query	True	string	推奨事項を生成する必要があるリージョンを選択するために使用します。
scope	query	True	scope	予約のスコープ。
term	query	True	term	予約レコメンデーション期間の長さを指定します。
$filter	query		string	予約の推奨事項の詳細をフィルター処理するために使用されます。 properties/subscriptionId は、課金アカウントと課金プロファイルのパスに指定できます。

応答

名前	型	説明
200 OK	ReservationRecommendationDetailsModel	OK です。要求は成功しました。
204 No Content		推奨事項の詳細がない場合は、空の応答が送信されます。
Other Status Codes	HighCasedErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ReservationRecommendationsByBillingAccount-Legacy

ReservationRecommendationsByBillingProfile-Modern

ReservationRecommendationsByResourceGroup-Legacy

ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope=Shared&region=eastus&term=P1Y&lookBackPeriod=Last60Days&product=Standard_DS14_v2&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 1.482,
      "product": "Standard_DS14_v2",
      "region": "eastus",
      "reservationRate": 0.70570776255707,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 529550.326618951,
          "overageCost": 63253.5935111345,
          "quantity": 220,
          "reservationCost": 223102.452054792,
          "totalReservationCost": 286356.045565927,
          "savings": 243194.281053024
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 149335.025050147,
          "quantity": 179,
          "reservationCost": 181524.267808217,
          "totalReservationCost": 330859.292858364,
          "savings": 198691.033760586
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 195942.319606957,
          "quantity": 157,
          "reservationCost": 159214.022602738,
          "totalReservationCost": 355156.342209695,
          "savings": 174393.984409255
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 30975.2311896299,
          "quantity": 241,
          "reservationCost": 244398.595205477,
          "totalReservationCost": 275373.826395107,
          "savings": 254176.500223843
        }
      ],
      "lookBackPeriod": 60,
      "recommendedQuantity": 253,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2019-11-27T00:00:00",
      "lastConsumptionDate": "2020-01-25T21:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        275.95003899999995,
        275.916705,
        276,
        276,
        275.916725,
        275.916705,
        275.98335299999997,
        276,
        276,
        276,
        276,
        276,
        275.98335299999997,
        276,
        276,
        276,
        276,
        275.933352
      ],
      "usageGrain": "hourly"
    }
  }
}

Status code:: 204

ReservationRecommendationsByBillingProfile-Modern

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope=Shared&region=australiaeast&term=P1Y&lookBackPeriod=Last7Days&product=Standard_B2s&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "AUD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.0725,
      "product": "Standard_B2s",
      "region": "australiaeast",
      "reservationRate": 0.04414166531788041,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 632.8844720496894,
          "overageCost": 0,
          "quantity": 1,
          "reservationCost": 387.74038815226174,
          "totalReservationCost": 387.74038815226174,
          "savings": 245.1440838974277
        }
      ],
      "lookBackPeriod": 7,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2020-01-19T00:00:00",
      "lastConsumptionDate": "2020-01-25T17:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        0
      ],
      "usageGrain": "hourly"
    }
  }
}

Status code:: 204

ReservationRecommendationsByResourceGroup-Legacy

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "testGroup"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": "testGroup",
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Status code:: 204

ReservationRecommendationsBySubscription-Legacy

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2023-05-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Status code:: 204

定義

名前	説明
HighCasedErrorDetails	エラーの詳細。
HighCasedErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに示されています。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
lookBackPeriod	予約の推奨事項の結果の基になっている期間をフィルター処理します。
ReservationRecommendationDetailsCalculatedSavingsProperties	推定節約額の詳細。コストと節約は、この期間で見積もります。
ReservationRecommendationDetailsModel	予約の推奨事項の詳細。
ReservationRecommendationDetailsResourceProperties	リソースの詳細。
ReservationRecommendationDetailsSavingsProperties	推定節約額の詳細。
ReservationRecommendationDetailsUsageProperties	推奨事項の計算に使用された使用状況データの履歴に関する詳細。
scope	予約のスコープ。
term	予約レコメンデーション期間の長さを指定します。

HighCasedErrorDetails

エラーの詳細。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

HighCasedErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに示されています。

いくつかのエラー応答:

429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

名前	型	説明
error	HighCasedErrorDetails	エラーの詳細。

lookBackPeriod

予約の推奨事項の結果の基になっている期間をフィルター処理します。

名前	型	説明
Last30Days	string	推奨事項に 30 日間のデータを使用する
Last60Days	string	推奨事項に 60 日間のデータを使用する
Last7Days	string	推奨事項に 7 日間のデータを使用する

ReservationRecommendationDetailsCalculatedSavingsProperties

推定節約額の詳細。コストと節約は、この期間で見積もります。

名前	型	説明
onDemandCost	number	予約なしのコスト。ハードウェアとソフトウェアのコストが含まれます。
overageCost	number	予約の対象とされないリソースのハードウェアとソフトウェアのコスト。
quantity	number	計算された節約の数量。
reservationCost	number	予約の対象となるリソースのハードウェアコスト。
reservedUnitCount	number	節約の計算に使用される予約ユニットの数。仮想マシンの場合は常に 1。
savings	number	予約の推奨数量を購入して保存された金額。これは onDemandCost - totalReservationCost と同じです。
totalReservationCost	number	予約コスト + 予約の対象となるリソースのソフトウェアコスト + 超過コスト。

ReservationRecommendationDetailsModel

予約の推奨事項の詳細。

名前	型	説明
etag	string	リソースの etag。
id	string	イベントの完全修飾 ARM ID。
location	string	リソースの場所。
name	string	イベントを一意に識別する ID。
properties.currency	string	コストと節約のための ISO 4217 通貨コード識別子
properties.resource	ReservationRecommendationDetailsResourceProperties	リソース固有のプロパティ。
properties.resourceGroup	string	リソースグループ。
properties.savings	ReservationRecommendationDetailsSavingsProperties	推奨事項の節約情報。
properties.scope	string	予約のスコープ (例: 単一または共有)。
properties.usage	ReservationRecommendationDetailsUsageProperties	推定節約額の計算に使用される使用状況の履歴の詳細。
sku	string	Resource SKU
tags	object	リソースタグ。
type	string	リソースの種類。

ReservationRecommendationDetailsResourceProperties

リソースの詳細。

名前	型	説明
appliedScopes	string[]	予約が適用されるサブスクリプションの一覧。
onDemandRate	number	リソースの時間単位のオンデマンドレート。ハードウェアレートのみが含まれます。つまり、ソフトウェアレートは含まれません。
product	string	Azure 製品例: Standard_E8s_v3など。
region	string	Azure リソースリージョン ex:EastUS、WestUS など
reservationRate	number	リソースの時間単位の予約率。用語によって異なります。
resourceType	string	Azure リソースの種類。

ReservationRecommendationDetailsSavingsProperties

推定節約額の詳細。

名前	型	説明
calculatedSavings	ReservationRecommendationDetailsCalculatedSavingsProperties[]	計算された節約の一覧。
lookBackPeriod	integer	推奨事項の計算に使用された、振り返る使用量の日数。
recommendedQuantity	number	リソースの推奨ユニット数。
reservationOrderTerm	string	予約の期間 (例: P1Y または P3Y)。
savingsType	string	節約の種類 (例: インスタンス)。
unitOfMeasure	string	測定単位例: 時間など

ReservationRecommendationDetailsUsageProperties

推奨事項の計算に使用された使用状況データの履歴に関する詳細。

名前	型	説明
firstConsumptionDate	string	推奨事項の計算を振り返る際に使用される最初の使用日。
lastConsumptionDate	string	推奨事項の計算を振り返る最後の使用日。
lookBackUnitType	string	使用状況データの値が表す内容 (仮想マシンインスタンスなど)。
usageData	number[]	リソース使用量の履歴の内訳。値は、firstConsumptionDate と lastConsumptionDate の間の使用順です。
usageGrain	string	使用状況データで表される値の粒度 (時間単位など)。

scope

予約のスコープ。

名前	型	説明
Shared	string
Single	string

term

予約レコメンデーション期間の長さを指定します。

名前	型	説明
P1Y	string	1 年間の予約期間
P3Y	string	3年間の予約期間

Reservation Recommendation Details - Get

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

ReservationRecommendationsByBillingAccount-Legacy

Sample Request

Sample Response

ReservationRecommendationsByBillingProfile-Modern

Sample Request

Sample Response

ReservationRecommendationsByResourceGroup-Legacy

Sample Request

Sample Response

ReservationRecommendationsBySubscription-Legacy

Sample Request

Sample Response

定義

HighCasedErrorDetails

HighCasedErrorResponse

lookBackPeriod

ReservationRecommendationDetailsCalculatedSavingsProperties

ReservationRecommendationDetailsModel

ReservationRecommendationDetailsResourceProperties

ReservationRecommendationDetailsSavingsProperties

ReservationRecommendationDetailsUsageProperties

scope

term

その他のリソース