Benefit Recommendations - List

참조

서비스:: Cost Management

API 버전:: 2024-08-01

구매 절감 플랜에 대한 권장 사항 목록입니다.

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

선택적 매개 변수:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
billingScope	path	True	string	혜택 권장 사항 작업과 연결된 범위입니다. 여기에는 구독 범위에 대한 '/subscriptions/{subscriptionId}/'가 포함됩니다. 리소스 그룹 범위에 대한 '/subscriptions/{subscriptionId}/{resourceGroupName}', 기업계약 범위에 대한 /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' 및 청구 프로필 범위에 대한 '/providers/Microsoft.Billing/billingAccountId}/{billingAccountId}/billingProfileId}'
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
$expand	query		string	속성/사용량, properties/allRecommendationDetails별로 속성을 확장하는 데 사용할 수 있습니다.
$filter	query		string	benefitRecommendations를 필터링하는 데 사용할 수 있습니다. 허용되는 값이 있는 properties/scope ['Single', 'Shared'] 및 기본값 'Shared'; 허용되는 값 ['Last7Days', 'Last30Days', 'Last60Days'] 및 기본값 'Last60Days'가 있는 properties/lookBackPeriod; 허용되는 값 ['P1Y', 'P3Y'] 및 기본값 'P3Y'가 있는 properties/term; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	properties/armSkuName을 사용하여 권장 사항을 정렬할 수 있습니다. 저축 계획의 경우 결과는 기본적으로 순서대로 정렬됩니다. 이 절을 사용할 필요가 없습니다.

응답

Name	형식	Description
200 OK	benefitRecommendationsListResult	그래. 요청이 성공했습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

BenefitRecommendationsBillingAccountList

샘플 요청

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=2024-08-01

샘플 응답

상태 코드:: 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
            }
          ]
        }
      }
    }
  ]
}

정의

Name	Description
allSavingsBenefitDetails	혜택 권장 사항 세부 정보입니다.
allSavingsList	권장 사항 세부 정보가 포함된 모든 혜택 권장 사항 목록입니다.
benefitKind	예약 또는 저축 계획.
benefitRecommendationModel	혜택 계획 권장 사항 세부 정보입니다.
benefitRecommendationsListResult	혜택 권장 사항을 나열한 결과입니다.
ErrorDetails	오류의 세부 정보입니다.
ErrorResponse	오류 응답은 서비스에서 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다. 일부 오류 응답: 429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다. 503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
grain	사용량의 조직입니다. 지원되는 값: '시간별'
lookBackPeriod	권장 사항을 계산하기 위해 평가된 사용량 일 수입니다.
recommendationUsageDetails	컴퓨팅 혜택 권장 사항에 사용된 firstConsumptionDate와 lastConsumptionDate 간의 주문형 요금입니다.
sharedScopeBenefitRecommendationProperties	범위가 '공유'인 경우 혜택 권장 사항의 속성입니다.
singleScopeBenefitRecommendationProperties	범위가 'Single'인 경우 혜택 권장 사항의 속성입니다.
term	혜택의 기간입니다. 예를 들어 P1Y 또는 P3Y입니다.

allSavingsBenefitDetails

혜택 권장 사항 세부 정보입니다.

Name	형식	Description
averageUtilizationPercentage	number	이 약정을 사용하여 조회 기간의 'totalHours'에 대한 예상 평균 사용률입니다.
benefitCost	number	조회 기간에 'totalHours'에 대한 혜택이 있는 예상 비용입니다. (commitmentAmount * totalHours)와 같습니다.
commitmentAmount	number	commitmentGranularity의 약정 금액입니다.
coveragePercentage	number	이 약정을 통해 조회 기간의 'totalHours'에 대한 예상 혜택 적용 비율입니다.
overageCost	number	조회 기간의 'totalHours'에 대한 총 비용과 혜택 비용의 차이입니다.
savingsAmount	number	혜택의 권장 수량을 구매하여 조회 기간에 'totalHours'에 대해 저장한 금액입니다.
savingsPercentage	number	권장되는 혜택 수량을 구매하여 조회 기간의 'totalHours'에 대한 백분율로 절감됩니다.
totalCost	number	총 비용- 혜택 비용 및 초과분 비용의 합계입니다.
wastageCost	number	'benefitCost'의 사용되지 않은 것으로 추정됩니다.

allSavingsList

권장 사항 세부 정보가 포함된 모든 혜택 권장 사항 목록입니다.

Name	형식	Description
nextLink	string	결과의 다음 페이지에 대한 링크(URL)입니다.
value	allSavingsBenefitDetails[]	권장 사항 세부 정보가 포함된 혜택 권장 사항 목록입니다.

benefitKind

예약 또는 저축 계획.

Name	형식	Description
IncludedQuantity	string	이점은 IncludedQuantity입니다.
Reservation	string	혜택은 예약입니다.
SavingsPlan	string	이점은 SavingsPlan입니다.

benefitRecommendationModel

혜택 계획 권장 사항 세부 정보입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	예약 또는 저축 계획.
name	string	리소스의 이름
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	혜택 권장 사항의 속성입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

혜택 권장 사항을 나열한 결과입니다.

Name	형식	Description
nextLink	string	결과의 다음 페이지에 대한 링크(URL)입니다.
value	benefitRecommendationModel[]	혜택 권장 사항 목록입니다.

ErrorDetails

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

ErrorResponse

오류 응답은 서비스에서 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.

일부 오류 응답:

429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.

Name	형식	Description
error	ErrorDetails	오류의 세부 정보입니다.

grain

사용량의 조직입니다. 지원되는 값: '시간별'

Name	형식	Description
Daily	string	시간별 곡물은 일별 값에 해당합니다.
Hourly	string	시간별 곡물은 시간당 값에 해당합니다.
Monthly	string	시간별 곡물은 월별 값에 해당합니다.

lookBackPeriod

권장 사항을 계산하기 위해 평가된 사용량 일 수입니다.

Name	형식	Description
Last30Days	string	뒤를 돌아보는 데 30일이 사용되었습니다.
Last60Days	string	60일은 뒤를 돌아보는 데 사용되었습니다.
Last7Days	string	뒤를 돌아보는 데 사용된 7일.

recommendationUsageDetails

컴퓨팅 혜택 권장 사항에 사용된 firstConsumptionDate와 lastConsumptionDate 간의 주문형 요금입니다.

Name	형식	Description
charges	number[]	컴퓨팅 혜택 권장 사항에 사용된 firstConsumptionDate와 lastConsumptionDate 사이의 각 시간에 대한 주문형 요금입니다.
usageGrain	grain	사용량의 조직입니다. 지원되는 값: '시간별'

sharedScopeBenefitRecommendationProperties

범위가 '공유'인 경우 혜택 권장 사항의 속성입니다.

Name	형식	Description
allRecommendationDetails	allSavingsList	권장 사항 세부 정보가 포함된 모든 혜택 권장 사항 목록입니다.
armSkuName	string	ARM SKU 이름입니다. 저축 계획에 대한 'Compute_Savings_Plan'.
commitmentGranularity	grain	제안된 약정 금액의 곡물입니다. 지원되는 값: '시간별'
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'인 경우 혜택 권장 사항의 속성입니다.

Name	형식	Description
allRecommendationDetails	allSavingsList	권장 사항 세부 정보가 포함된 모든 혜택 권장 사항 목록입니다.
armSkuName	string	ARM SKU 이름입니다. 저축 계획에 대한 'Compute_Savings_Plan'.
commitmentGranularity	grain	제안된 약정 금액의 곡물입니다. 지원되는 값: '시간별'
costWithoutBenefit	number	혜택이 없는 현재 비용은 조회 기간의 'totalHours'에 해당합니다.
currencyCode	string	비용 및 절감 금액에 대한 ISO 4217 통화 코드 식별자입니다.
firstConsumptionDate	string	권장 사항을 계산하기 위해 다시 살펴보는 데 사용되는 첫 번째 사용 날짜입니다.
lastConsumptionDate	string	권장 사항을 계산하기 위해 다시 살펴보는 데 사용되는 마지막 사용 날짜입니다.
lookBackPeriod	lookBackPeriod	권장 사항을 계산하기 위해 평가된 사용량 일 수입니다.
recommendationDetails	allSavingsBenefitDetails	제안된 권장 사항의 세부 정보입니다.
resourceGroup	string	이 단일 범위 권장 사항이 적용되는 리소스 그룹입니다. '단일' 범위 및 'ResourceGroup' 요청 범위에 대한 권장 사항이 있는 경우에만 적용됩니다.
scope	string: Single	혜택 범위입니다. 예를 들어 단일 또는 공유입니다.
subscriptionId	string	이 단일 범위 권장 사항이 적용되는 구독 ID입니다. 권장 사항이 '단일' 범위에 해당하는 경우에만 적용됩니다.
term	term	혜택의 기간입니다. 예를 들어 P1Y 또는 P3Y입니다.
totalHours	integer	비용이 적용되는 총 시간입니다. 속성 'properties/usage/charges'의 레코드 수와 같습니다.
usage	recommendationUsageDetails	컴퓨팅 혜택 권장 사항에 사용된 firstConsumptionDate와 lastConsumptionDate 간의 주문형 요금입니다.

term

혜택의 기간입니다. 예를 들어 P1Y 또는 P3Y입니다.

Name	형식	Description
P1Y	string	혜택 기간은 1년입니다.
P3Y	string	혜택 기간은 3년입니다.

다음을 통해 공유