Benefit Recommendations - List
節約プランの購入に関する推奨事項の一覧。
GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01
GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01&$filter={$filter}&$orderby={$orderby}&$expand={$expand}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
billing
|
path | True |
string |
特典の推奨操作に関連付けられているスコープ。 これには、サブスクリプション スコープの場合は '/subscriptions/{subscriptionId}/'、リソース グループ スコープの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、エンタープライズ契約スコープの場合は /providers/Microsoft.Billing/billingAccountId}'、課金プロファイル スコープの場合は '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingProfileId}' が含まれます。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
$expand
|
query |
string |
プロパティの展開に使用できます。properties/usage、properties/allRecommendationDetails |
|
|
$filter
|
query |
string |
benefitRecommendations をフィルター処理するために使用できます。許可された値 ['Single'、'Shared']、および既定値 'Shared' を持つプロパティ/スコープ。and properties/lookBackPeriod with allowed value ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days';properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y';properties/subscriptionId;properties/resourceGroup |
|
|
$orderby
|
query |
string |
properties/armSkuName で推奨事項を並べ替えるために使用できます。 節約計画の場合、結果は既定で順序付けされます。 この句を使用する必要はありません。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | あなたのユーザー アカウントになりすます |
例
|
Benefit |
|
Benefit |
BenefitRecommendationsBillingAccountList
要求のサンプル
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01&$filter=properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails
応答のサンプル
{
"value": [
{
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.CostManagement/benefitRecommendations",
"id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
"kind": "SavingsPlan",
"properties": {
"allRecommendationDetails": {
"value": [
{
"averageUtilizationPercentage": 99.33,
"benefitCost": 52.002,
"commitmentAmount": 0.164,
"coveragePercentage": 54.609,
"overageCost": 144.841,
"savingsAmount": 21.424,
"savingsPercentage": 9.815,
"totalCost": 196.843,
"wastageCost": 0.035
},
{
"averageUtilizationPercentage": 81.474,
"benefitCost": 83.754,
"commitmentAmount": 0.161,
"coveragePercentage": 56.748,
"overageCost": 120.389,
"savingsAmount": 14.124,
"savingsPercentage": 6.47,
"totalCost": 204.143,
"wastageCost": 0.1
}
]
},
"armSkuName": "Compute_Savings_Plan",
"commitmentGranularity": "Hourly",
"costWithoutBenefit": 218.267,
"currencyCode": "USD",
"firstConsumptionDate": "2022-10-18T00:00:00Z",
"lastConsumptionDate": "2022-10-25T00:00:00Z",
"lookBackPeriod": "Last7Days",
"recommendationDetails": {
"averageUtilizationPercentage": 99.33,
"benefitCost": 52.002,
"commitmentAmount": 0.164,
"coveragePercentage": 54.609,
"overageCost": 144.841,
"savingsAmount": 21.424,
"savingsPercentage": 9.815,
"totalCost": 196.843,
"wastageCost": 0.035
},
"scope": "Shared",
"term": "P1Y",
"totalHours": 168,
"usage": {
"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
],
"usageGrain": "Hourly"
}
}
}
]
}
BenefitRecommendationsManagementGroupList
要求のサンプル
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01&$filter=properties/scope eq 'ManagementGroup' AND properties/managementGroupId eq '/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000001' AND properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails
応答のサンプル
{
"value": [
{
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.CostManagement/benefitRecommendations",
"id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
"kind": "SavingsPlan",
"properties": {
"allRecommendationDetails": {
"value": [
{
"averageUtilizationPercentage": 99.33,
"benefitCost": 52.002,
"commitmentAmount": 0.164,
"coveragePercentage": 54.609,
"overageCost": 144.841,
"savingsAmount": 21.424,
"savingsPercentage": 9.815,
"totalCost": 196.843,
"wastageCost": 0.035
}
]
},
"armSkuName": "Compute_Savings_Plan",
"commitmentGranularity": "Hourly",
"costWithoutBenefit": 218.267,
"currencyCode": "USD",
"firstConsumptionDate": "2022-10-18T00:00:00Z",
"lastConsumptionDate": "2022-10-25T00:00:00Z",
"lookBackPeriod": "Last7Days",
"recommendationDetails": {
"averageUtilizationPercentage": 99.33,
"benefitCost": 52.002,
"commitmentAmount": 0.164,
"coveragePercentage": 54.609,
"overageCost": 144.841,
"savingsAmount": 21.424,
"savingsPercentage": 9.815,
"totalCost": 196.843,
"wastageCost": 0.035
},
"managementGroupId": "/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000001",
"tenantId": "00000000-0000-0000-0000-000000000001",
"scope": "ManagementGroup",
"term": "P1Y",
"totalHours": 168,
"usage": {
"charges": [
1,
1,
0,
1,
1,
1,
1,
1
],
"usageGrain": "Hourly"
}
}
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
all |
特典の推奨事項の詳細。 |
|
all |
推奨事項の詳細を含むすべての特典の推奨事項の一覧。 |
|
Benefit |
利益の種類や種類。 |
|
benefit |
特典プランの推奨事項の詳細。 |
|
benefit |
特典に関する推奨事項を一覧表示した結果。 |
|
created |
リソースを作成した ID の種類。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。 \n\nいくつかのエラー応答:\n\n * 429 TooManyRequests - リクエストがスロットルされています。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。 \n\n * 503 サービス不可 - サービスが一時的に利用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。 |
| Grain |
粒は価値に対応します。 |
|
Look |
かつては振り返る日数。 |
|
management |
福利厚生推奨の特性は、範囲が「ManagementGroup」である場合に適用されます。 |
|
recommendation |
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。 |
| Scope |
いわば推奨範囲のようなものです。 |
|
shared |
スコープが "共有" の場合の特典の推奨事項のプロパティ。 |
|
single |
スコープが "Single" の場合の特典の推奨事項のプロパティ。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
| Term |
粒は価値に対応します。 |
allSavingsBenefitDetails
特典の推奨事項の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| averageUtilizationPercentage |
number (decimal) |
このコミットメントを使用した、ルックバック期間の "totalHours" の推定平均使用率の割合。 |
| benefitCost |
number (decimal) |
ルックバック期間の "totalHours" の特典を含む推定コスト。 (commitmentAmount * totalHours) に等しい |
| commitmentAmount |
number (decimal) |
コミットメントのコミットメント金額です。 |
| coveragePercentage |
number (decimal) |
このコミットメントを使用した、ルックバック期間中の "totalHours" の推定特典カバレッジ率。 |
| overageCost |
number (decimal) |
ルックバック期間の "totalHours" の合計コストと利益コストの差。 |
| savingsAmount |
number (decimal) |
特典の推奨数量を購入することで、ルックバック期間の "totalHours" に対して保存された金額。 |
| savingsPercentage |
number (decimal) |
推奨される特典の数量を購入することで、ルックバック期間の "totalHours" の節約率をパーセントで指定します。 |
| totalCost |
number (decimal) |
合計コスト。これは、特典コストと超過コストの合計です。 |
| wastageCost |
number (decimal) |
'benefitCost' の未使用部分の見積もり。 |
allSavingsList
推奨事項の詳細を含むすべての特典の推奨事項の一覧。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string (uri) |
結果の次のページへのリンク (URL)。 |
| value |
推奨事項の詳細を含む特典の推奨事項の一覧。. |
BenefitKind
利益の種類や種類。
| 値 | 説明 |
|---|---|
| IncludedQuantity |
特典は IncludedQuantity です。 |
| Reservation |
特典は予約です。 |
| SavingsPlan |
利点は SavingsPlan です。 |
benefitRecommendationModel
特典プランの推奨事項の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| kind |
Reservation または SavingsPlan。 |
|
| name |
string |
リソースの名前 |
| properties | benefitRecommendationProperties: |
特典の推奨事項のプロパティ。 |
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
benefitRecommendationsListResult
特典に関する推奨事項を一覧表示した結果。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string |
結果の次のページへのリンク (URL)。 |
| value |
特典の推奨事項の一覧。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorDetails
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
ErrorResponse
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。 \n\nいくつかのエラー応答:\n\n * 429 TooManyRequests - リクエストがスロットルされています。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。 \n\n * 503 サービス不可 - サービスが一時的に利用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |
Grain
粒は価値に対応します。
| 値 | 説明 |
|---|---|
| Hourly |
時間単位グレインは、1 時間あたりの値に対応します。 |
| Daily |
時間単位のグレインは、1 日あたりの値に対応します。 |
| Monthly |
時間単位グレインは、1 か月あたりの値に対応します。 |
LookBackPeriod
かつては振り返る日数。
| 値 | 説明 |
|---|---|
| Last7Days |
7 日が振り返るために使用されます。 |
| Last30Days |
30 日が振り返るために使用されます。 |
| Last60Days |
振り返るために使用された 60 日。 |
managementGroupScopeBenefitRecommendationProperties
福利厚生推奨の特性は、範囲が「ManagementGroup」である場合に適用されます。
| 名前 | 型 | 説明 |
|---|---|---|
| allRecommendationDetails |
推奨事項の詳細を含むすべての特典の推奨事項の一覧。 |
|
| armSkuName |
string |
ARM SKU 名。 SavingsPlan の 'Compute_Savings_Plan' です。 |
| commitmentGranularity |
提案されたコミットメント額のグレイン。 サポートされている値: 'Hourly' |
|
| costWithoutBenefit |
number (decimal) |
メリットのない現在のコストは、ルックバック期間の "totalHours" に対応します。 |
| currencyCode |
string |
コストと節約額の ISO 4217 通貨コード識別子。 |
| firstConsumptionDate |
string (date-time) |
推奨事項の計算を振り返る際に使用される最初の使用日。 |
| lastConsumptionDate |
string (date-time) |
推奨事項を計算するために振り返る最後の使用日。 |
| lookBackPeriod |
推奨事項を計算するために評価された使用状況の日数。 |
|
| managementGroupId |
string |
この管理グループのスコープ推奨対象となる管理グループの完全限定識別子、フォーマットの/providers/Microsoft。Management/managementGroups/{managementGroupId}. 推奨が「ManagementGroup」の範囲に関する場合にのみ適用されます。 |
| recommendationDetails |
提案された推奨事項の詳細。 |
|
| scope |
string:
Management |
特典スコープ。 たとえば、単一または共有です。 |
| tenantId |
string |
管理グループに関連付けられたテナントID。 管理グループIDが埋め込まれた場合にのみ入力されます。 |
| term |
特典の期間。 たとえば、P1Y や P3Y です。 |
|
| totalHours |
integer (int32) |
コストの対象となる合計時間。 プロパティ 'properties/usage/charges' 内のレコードの数と同じです。 |
| usage |
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。 |
recommendationUsageDetails
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。
| 名前 | 型 | 説明 |
|---|---|---|
| charges |
number[] (decimal) |
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間の各時間のオンデマンド料金。 |
| usageGrain |
使用状況の粒度。 サポートされている値: 'Hourly' |
Scope
いわば推奨範囲のようなものです。
| 値 | 説明 |
|---|---|
| Single |
単一スコープの推奨です。 |
| Shared |
共通のスコープ推奨。 |
| ManagementGroup |
管理グループの範囲提案。 |
sharedScopeBenefitRecommendationProperties
スコープが "共有" の場合の特典の推奨事項のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| allRecommendationDetails |
推奨事項の詳細を含むすべての特典の推奨事項の一覧。 |
|
| armSkuName |
string |
ARM SKU 名。 SavingsPlan の 'Compute_Savings_Plan' です。 |
| commitmentGranularity |
提案されたコミットメント額のグレイン。 サポートされている値: 'Hourly' |
|
| costWithoutBenefit |
number (decimal) |
メリットのない現在のコストは、ルックバック期間の "totalHours" に対応します。 |
| currencyCode |
string |
コストと節約額の ISO 4217 通貨コード識別子。 |
| firstConsumptionDate |
string (date-time) |
推奨事項の計算を振り返る際に使用される最初の使用日。 |
| lastConsumptionDate |
string (date-time) |
推奨事項を計算するために振り返る最後の使用日。 |
| lookBackPeriod |
推奨事項を計算するために評価された使用状況の日数。 |
|
| recommendationDetails |
提案された推奨事項の詳細。 |
|
| scope |
string:
Shared |
特典スコープ。 たとえば、単一または共有です。 |
| term |
特典の期間。 たとえば、P1Y や P3Y です。 |
|
| totalHours |
integer (int32) |
コストの対象となる合計時間。 プロパティ 'properties/usage/charges' 内のレコードの数と同じです。 |
| usage |
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。 |
singleScopeBenefitRecommendationProperties
スコープが "Single" の場合の特典の推奨事項のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| allRecommendationDetails |
推奨事項の詳細を含むすべての特典の推奨事項の一覧。 |
|
| armSkuName |
string |
ARM SKU 名。 SavingsPlan の 'Compute_Savings_Plan' です。 |
| commitmentGranularity |
提案されたコミットメント額のグレイン。 サポートされている値: 'Hourly' |
|
| costWithoutBenefit |
number (decimal) |
メリットのない現在のコストは、ルックバック期間の "totalHours" に対応します。 |
| currencyCode |
string |
コストと節約額の ISO 4217 通貨コード識別子。 |
| firstConsumptionDate |
string (date-time) |
推奨事項の計算を振り返る際に使用される最初の使用日。 |
| lastConsumptionDate |
string (date-time) |
推奨事項を計算するために振り返る最後の使用日。 |
| lookBackPeriod |
推奨事項を計算するために評価された使用状況の日数。 |
|
| recommendationDetails |
提案された推奨事項の詳細。 |
|
| resourceGroup |
string |
この単一スコープの推奨事項の対象となるリソース グループ。 推奨事項が 'Single' スコープと 'ResourceGroup' 要求スコープの場合にのみ適用されます。 |
| scope |
string:
Single |
特典スコープ。 たとえば、単一または共有です。 |
| subscriptionId |
string |
この単一スコープの推奨事項の対象となるサブスクリプション ID。 推奨事項が 'Single' スコープの場合にのみ適用されます。 |
| term |
特典の期間。 たとえば、P1Y や P3Y です。 |
|
| totalHours |
integer (int32) |
コストの対象となる合計時間。 プロパティ 'properties/usage/charges' 内のレコードの数と同じです。 |
| usage |
特典の推奨事項を計算するために使用された firstConsumptionDate と lastConsumptionDate の間のオンデマンド料金。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |
Term
粒は価値に対応します。
| 値 | 説明 |
|---|---|
| P1Y |
特典期間は 1 年です。 |
| P3Y |
特典期間は 3 年です。 |