Benefit Recommendations - List

リファレンス

Service:: Cost Management

API Version:: 2023-11-01

節約プランの購入に関する推奨事項の一覧。

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2023-11-01

With optional parameters:

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?$filter={$filter}&$orderby={$orderby}&$expand={$expand}&api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
billingScope	path	True	string	特典のレコメンデーション操作に関連付けられているスコープ。これには、サブスクリプションスコープの '/subscriptions/{subscriptionId}/'、リソースグループスコープの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、エンタープライズ契約スコープの場合は /providers/Microsoft.Billing/billingAccountId}'、課金プロファイルスコープの場合は '/providers/Microsoft.Billing/billingAccounts/{billingProfiles/{billingProfileId}' が含まれます。
api-version	query	True	string	この操作に使用する API バージョン。
$expand	query		string	プロパティを展開するために使用できます。properties/usage、properties/allRecommendationDetails
$filter	query		string	benefitRecommendations をフィルター処理するために使用できます。許可された値 ['Single'、'Shared']、既定値 'Shared' を持つプロパティ/スコープ。および properties/lookBackPeriod で、値 ['Last7Days'、'Last30Days'、'Last60Days']、既定値 'Last60Days' が指定されています。properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y';properties/subscriptionId;properties/resourceGroup
$orderby	query		string	properties/armSkuName で推奨事項を並べ替えるために使用できます。節約プランの場合、結果は既定で順に並べられます。この句を使用する必要はありません。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

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

例

BenefitRecommendationsBillingAccountList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?$filter=properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails&api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.CostManagement/benefitRecommendations",
      "kind": "SavingsPlan",
      "properties": {
        "firstConsumptionDate": "2022-10-18T00:00:00Z",
        "lastConsumptionDate": "2022-10-25T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "totalHours": 168,
        "usage": {
          "usageGrain": "Hourly",
          "charges": [
            1,
            1,
            0,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            2,
            2,
            2,
            2
          ]
        },
        "armSkuName": "Compute_Savings_Plan",
        "term": "P1Y",
        "commitmentGranularity": "Hourly",
        "currencyCode": "USD",
        "costWithoutBenefit": 218.267,
        "scope": "Shared",
        "recommendationDetails": {
          "averageUtilizationPercentage": 99.33,
          "coveragePercentage": 54.609,
          "commitmentAmount": 0.164,
          "overageCost": 144.841,
          "benefitCost": 52.002,
          "savingsAmount": 21.424,
          "savingsPercentage": 9.815,
          "totalCost": 196.843,
          "wastageCost": 0.035
        },
        "allRecommendationDetails": {
          "value": [
            {
              "averageUtilizationPercentage": 99.33,
              "coveragePercentage": 54.609,
              "commitmentAmount": 0.164,
              "overageCost": 144.841,
              "benefitCost": 52.002,
              "savingsAmount": 21.424,
              "savingsPercentage": 9.815,
              "totalCost": 196.843,
              "wastageCost": 0.035
            },
            {
              "averageUtilizationPercentage": 81.474,
              "coveragePercentage": 56.748,
              "commitmentAmount": 0.161,
              "overageCost": 120.389,
              "benefitCost": 83.754,
              "savingsAmount": 14.124,
              "savingsPercentage": 6.47,
              "totalCost": 204.143,
              "wastageCost": 0.1
            }
          ]
        }
      }
    }
  ]
}

定義

名前	説明
allSavingsBenefitDetails	特典の推奨事項の詳細。
allSavingsList	推奨事項の詳細を含むすべての特典の推奨事項の一覧。
benefitKind	Reservation または SavingsPlan。
benefitRecommendationModel	特典プランの推奨事項の詳細。
benefitRecommendationsListResult	特典に関する推奨事項を一覧表示した結果。
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
grain	使用状況の粒度。サポートされる値: 'Hourly'
lookBackPeriod	推奨事項を計算するために評価された使用量の日数。
recommendationUsageDetails	特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。
sharedScopeBenefitRecommendationProperties	スコープが 'Shared' の場合の特典の推奨事項のプロパティ。
singleScopeBenefitRecommendationProperties	スコープが "Single" の場合の特典に関する推奨事項のプロパティ。
term	特典の期間。たとえば、P1Y や P3Y などです。

allSavingsBenefitDetails

特典の推奨事項の詳細。

名前	型	説明
averageUtilizationPercentage	number	このコミットメントを使用した、ルックバック期間中の "totalHours" の推定平均使用率の割合。
benefitCost	number	ルックバック期間の "totalHours" の特典を含む推定コスト。と等しい (commitmentAmount * totalHours)
commitmentAmount	number	コミットメントのコミットメント金額Granularity。
coveragePercentage	number	このコミットメントを使用して、ルックバック期間中の "totalHours" の推定特典カバレッジ率。
overageCost	number	ルックバック期間の "totalHours" の合計コストと利益コストの差。
savingsAmount	number	特典の推奨数量を購入して、ルックバック期間の "totalHours" に対して保存された金額。
savingsPercentage	number	推奨される特典の数量を購入することで、ルックバック期間の "totalHours" のパーセンテージの節約。
totalCost	number	総コスト。これは、特典コストと超過コストの合計です。
wastageCost	number	'benefitCost' の未使用部分の見積もり。

allSavingsList

推奨事項の詳細を含むすべての特典の推奨事項の一覧。

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
value	allSavingsBenefitDetails[]	推奨事項の詳細を含む特典の推奨事項の一覧。.

benefitKind

Reservation または SavingsPlan。

名前	型	説明
IncludedQuantity	string	特典は IncludedQuantity です。
Reservation	string	特典は予約です。
SavingsPlan	string	利点は SavingsPlan です。

benefitRecommendationModel

特典プランの推奨事項の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservation または SavingsPlan。
name	string	リソースの名前
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	特典に関する推奨事項のプロパティ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

特典に関する推奨事項を一覧表示した結果。

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
value	benefitRecommendationModel[]	特典に関する推奨事項の一覧。

ErrorDetails

エラーの詳細。

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

ErrorResponse

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

いくつかのエラー応答:

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

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

grain

使用状況の粒度。サポートされる値: 'Hourly'

名前	型	説明
Daily	string	時間単位のグレインは、1 日あたりの値に対応します。
Hourly	string	時間単位のグレインは、1 時間あたりの値に対応します。
Monthly	string	時間単位のグレインは、1 か月あたりの値に対応します。

lookBackPeriod

推奨事項を計算するために評価された使用量の日数。

名前	型	説明
Last30Days	string	30 日を振り返るために使用されます。
Last60Days	string	60 日を振り返るために使用されます。
Last7Days	string	振り返るために使用された7日間。

recommendationUsageDetails

特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。

名前	型	説明
charges	number[]	特典の推奨事項を計算するために使用された firstConsumptionDate から lastConsumptionDate までの各時間のオンデマンド料金。
usageGrain	grain	使用状況の粒度。サポートされる値: 'Hourly'

sharedScopeBenefitRecommendationProperties

スコープが 'Shared' の場合の特典の推奨事項のプロパティ。

名前	型	説明
allRecommendationDetails	allSavingsList	推奨事項の詳細を含むすべての特典の推奨事項の一覧。
armSkuName	string	ARM SKU 名。 SavingsPlan の 'Compute_Savings_Plan' です。
commitmentGranularity	grain	提案されたコミットメント額の粒度。サポートされる値: 'Hourly'
costWithoutBenefit	number	メリットのない現在のコストは、ルックバック期間の "totalHours" に対応します。
currencyCode	string	コストと節約額の ISO 4217 通貨コード識別子。
firstConsumptionDate	string	推奨事項の計算を振り返る際に使用される最初の使用日。
lastConsumptionDate	string	推奨事項の計算を振り返る際に使用された最後の使用日。
lookBackPeriod	lookBackPeriod	推奨事項を計算するために評価された使用量の日数。
recommendationDetails	allSavingsBenefitDetails	提案された推奨事項の詳細。
scope	string: Shared	特典スコープ。たとえば、単一または共有です。
term	term	特典の期間。たとえば、P1Y や P3Y などです。
totalHours	integer	コストがカバーされる合計時間。プロパティ 'properties/usage/charges' 内のレコードの数と同じです。
usage	recommendationUsageDetails	特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。

singleScopeBenefitRecommendationProperties

スコープが "Single" の場合の特典に関する推奨事項のプロパティ。

名前	型	説明
allRecommendationDetails	allSavingsList	推奨事項の詳細を含むすべての特典の推奨事項の一覧。
armSkuName	string	ARM SKU 名。 SavingsPlan の 'Compute_Savings_Plan' です。
commitmentGranularity	grain	提案されたコミットメント額の粒度。サポートされる値: 'Hourly'
costWithoutBenefit	number	メリットのない現在のコストは、ルックバック期間の "totalHours" に対応します。
currencyCode	string	コストと節約額の ISO 4217 通貨コード識別子。
firstConsumptionDate	string	推奨事項の計算を振り返る際に使用される最初の使用日。
lastConsumptionDate	string	推奨事項の計算を振り返る際に使用された最後の使用日。
lookBackPeriod	lookBackPeriod	推奨事項を計算するために評価された使用量の日数。
recommendationDetails	allSavingsBenefitDetails	提案された推奨事項の詳細。
resourceGroup	string	この単一スコープの推奨事項の対象となるリソースグループ。推奨事項が 'Single' スコープと 'ResourceGroup' 要求スコープの場合にのみ適用されます。
scope	string: Single	特典スコープ。たとえば、単一または共有です。
subscriptionId	string	この 1 つのスコープの推奨事項の対象となるサブスクリプション ID。推奨事項が 'Single' スコープの場合にのみ適用されます。
term	term	特典の期間。たとえば、P1Y や P3Y などです。
totalHours	integer	コストがカバーされる合計時間。プロパティ 'properties/usage/charges' 内のレコードの数と同じです。
usage	recommendationUsageDetails	特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。

term

特典の期間。たとえば、P1Y や P3Y などです。

名前	型	説明
P1Y	string	給付期間は 1 年です。
P3Y	string	給付期間は3年です。

次の方法で共有