Benefit Recommendations - List

Başvuru

Service:: Cost Management

API Version:: 2023-11-01

Tasarruf planı satın alma önerilerinin listesi.

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
billingScope	path	True	string	Avantaj önerisi işlemleriyle ilişkili kapsam. Buna abonelik kapsamı için '/subscriptions/{subscriptionId}/', kaynak grubu kapsamı için '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', kurumsal anlaşma kapsamı için /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' ve faturalama profili kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfileId}' dahildir
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
$expand	query		string	Özellikleri genişletmek için şu şekilde kullanılabilir: properties/usage, properties/allRecommendationDetails
$filter	query		string	benefitRecommendations'ı filtrelemek için kullanılabilir: izin verilen ['Tek', 'Paylaşılan'] ve varsayılan değer 'Paylaşılan' olan özellikler/kapsam; ve properties/lookBackPeriod; izin verilen değerler ['Last7Days', 'Last30Days', 'Last60Days'] ve varsayılan değer 'Last60Days'; ['P1Y', 'P3Y'] ve varsayılan değeri 'P3Y' olan özellikler/terim; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Önerileri şu şekilde sıralamak için kullanılabilir: properties/armSkuName. Tasarruf planı için sonuçlar varsayılan olarak sıralı olur. Bu yan tümceyi kullanmanıza gerek yoktur.

Yanıtlar

Name	Tür	Description
200 OK	benefitRecommendationsListResult	Tamam ögesini seçin. İstek başarılı oldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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
            }
          ]
        }
      }
    }
  ]
}

Tanımlar

Name	Description
allSavingsBenefitDetails	Avantaj önerisi ayrıntıları.
allSavingsList	Öneri ayrıntılarını içeren tüm avantaj önerilerinin listesi.
benefitKind	Rezervasyon veya Tasarruf Planı.
benefitRecommendationModel	avantaj planı öneri ayrıntıları.
benefitRecommendationsListResult	Avantaj önerilerini listelemenin sonucu.
ErrorDetails	Hatanın ayrıntıları.
ErrorResponse	Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir. Bazı Hata yanıtları: 429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin. 503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.
grain	Kullanımın dilimi. Desteklenen değerler: 'Hourly'
lookBackPeriod	Öneriler hesaplanırken değerlendirilen kullanım gün sayısı.
recommendationUsageDetails	bilgi işlem avantajı önerileri için kullanılan firstConsumptionDate ile lastConsumptionDate arasındaki isteğe bağlı ücretler.
sharedScopeBenefitRecommendationProperties	Kapsam 'Paylaşılan' olduğunda avantaj önerisinin özellikleri.
singleScopeBenefitRecommendationProperties	Kapsam 'Tek' olduğunda avantaj önerilerinin özellikleri.
term	Avantajın dönem süresi. Örneğin, P1Y veya P3Y.

allSavingsBenefitDetails

Avantaj önerisi ayrıntıları.

Name	Tür	Description
averageUtilizationPercentage	number	Bu taahhütle, geriye bakma dönemindeki 'totalHours' için tahmini ortalama kullanım yüzdesi.
benefitCost	number	Geriye bakma döneminde 'totalHours' için avantajlı tahmini maliyet. Eşittir (commitmentAmount * totalHours)
commitmentAmount	number	CommitmentGranularity'deki taahhüt miktarı.
coveragePercentage	number	Bu taahhütle, geriye bakma dönemindeki 'totalHours' için tahmini avantaj kapsamı yüzdesi.
overageCost	number	Geriye bakma dönemindeki 'totalHours' için toplam maliyet ve avantaj maliyeti arasındaki fark.
savingsAmount	number	Avantajın önerilen miktarını satın alarak geriye bakma döneminde 'totalHours' için kaydedilen tutar.
savingsPercentage	number	Önerilen avantaj miktarını satın alarak geriye bakma dönemindeki 'totalHours' için yüzde cinsinden tasarruf.
totalCost	number	Toplam maliyet; bu, avantaj maliyeti ve fazla kullanım maliyetinin toplamıdır.
wastageCost	number	'benefitCost' öğesinin tahmini kullanılmamış kısmı.

allSavingsList

Öneri ayrıntılarını içeren tüm avantaj önerilerinin listesi.

Name	Tür	Description
nextLink	string	Sonuçların sonraki sayfasına bağlantı (URL).
value	allSavingsBenefitDetails[]	Öneri ayrıntılarını içeren avantaj önerileri listesi..

benefitKind

Rezervasyon veya Tasarruf Planı.

Name	Tür	Description
IncludedQuantity	string	Avantaj IncludedQuantity'dir.
Reservation	string	Avantaj Rezervasyondur.
SavingsPlan	string	Avantaj, SavingsPlan'dır.

benefitRecommendationModel

avantaj planı öneri ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Rezervasyon veya Tasarruf Planı.
name	string	Kaynağın adı
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Avantaj önerilerinin özellikleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Avantaj önerilerini listelemenin sonucu.

Name	Tür	Description
nextLink	string	Sonuçların sonraki sayfasına bağlantı (URL).
value	benefitRecommendationModel[]	Avantaj önerileri listesi.

ErrorDetails

Hatanın ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

ErrorResponse

Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Bazı Hata yanıtları:

429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.

Name	Tür	Description
error	ErrorDetails	Hatanın ayrıntıları.

grain

Kullanımın dilimi. Desteklenen değerler: 'Hourly'

Name	Tür	Description
Daily	string	Saatlik dilim, günlük değere karşılık gelir.
Hourly	string	Saatlik dilim, saat başına değere karşılık gelir.
Monthly	string	Saatlik dilim, aylık değere karşılık gelir.

lookBackPeriod

Öneriler hesaplanırken değerlendirilen kullanım gün sayısı.

Name	Tür	Description
Last30Days	string	Geriye bakmak için 30 gün kullanılır.
Last60Days	string	60 gün geriye bakardım.
Last7Days	string	Geriye bakmak için 7 gün kullanılır.

recommendationUsageDetails

bilgi işlem avantajı önerileri için kullanılan firstConsumptionDate ile lastConsumptionDate arasındaki isteğe bağlı ücretler.

Name	Tür	Description
charges	number[]	bilgi işlem avantajı önerileri için kullanılan firstConsumptionDate ile lastConsumptionDate arasındaki her saat için isteğe bağlı ücretler.
usageGrain	grain	Kullanımın dilimi. Desteklenen değerler: 'Hourly'

sharedScopeBenefitRecommendationProperties

Kapsam 'Paylaşılan' olduğunda avantaj önerisinin özellikleri.

Name	Tür	Description
allRecommendationDetails	allSavingsList	Öneri ayrıntılarını içeren tüm avantaj önerilerinin listesi.
armSkuName	string	ARM SKU adı. SavingsPlan için 'Compute_Savings_Plan'.
commitmentGranularity	grain	Önerilen taahhüt miktarının dilimi. Desteklenen değerler: 'Hourly'
costWithoutBenefit	number	Avantajsız geçerli maliyet, geriye bakma dönemindeki 'totalHours'a karşılık gelir.
currencyCode	string	Maliyetler ve tasarruf tutarları için ISO 4217 para birimi kodu tanımlayıcısı.
firstConsumptionDate	string	Önerileri hesaplamaya geri dönmek için kullanılan ilk kullanım tarihi.
lastConsumptionDate	string	Önerileri hesaplamaya geri dönmek için kullanılan son kullanım tarihi.
lookBackPeriod	lookBackPeriod	Öneriler hesaplanırken değerlendirilen kullanım gün sayısı.
recommendationDetails	allSavingsBenefitDetails	Önerilen önerinin ayrıntıları.
scope	string: Shared	Avantaj kapsamı. Örneğin, Tek veya Paylaşılan.
term	term	Avantajın dönem süresi. Örneğin, P1Y veya P3Y.
totalHours	integer	Maliyetin karşılandığı toplam saat. 'properties/usage/charges' özelliğindeki kayıt sayısına eşittir.
usage	recommendationUsageDetails	bilgi işlem avantajı önerileri için kullanılan firstConsumptionDate ile lastConsumptionDate arasındaki isteğe bağlı ücretler.

singleScopeBenefitRecommendationProperties

Kapsam 'Tek' olduğunda avantaj önerilerinin özellikleri.

Name	Tür	Description
allRecommendationDetails	allSavingsList	Öneri ayrıntılarını içeren tüm avantaj önerilerinin listesi.
armSkuName	string	ARM SKU adı. SavingsPlan için 'Compute_Savings_Plan'.
commitmentGranularity	grain	Önerilen taahhüt miktarının dilimi. Desteklenen değerler: 'Hourly'
costWithoutBenefit	number	Avantajsız geçerli maliyet, geriye bakma dönemindeki 'totalHours'a karşılık gelir.
currencyCode	string	Maliyetler ve tasarruf tutarları için ISO 4217 para birimi kodu tanımlayıcısı.
firstConsumptionDate	string	Önerileri hesaplamaya geri dönmek için kullanılan ilk kullanım tarihi.
lastConsumptionDate	string	Önerileri hesaplamaya geri dönmek için kullanılan son kullanım tarihi.
lookBackPeriod	lookBackPeriod	Öneriler hesaplanırken değerlendirilen kullanım gün sayısı.
recommendationDetails	allSavingsBenefitDetails	Önerilen önerinin ayrıntıları.
resourceGroup	string	Bu tek kapsam önerisinin ilgili olduğu kaynak grubu. Yalnızca öneri 'Tek' kapsam ve 'ResourceGroup' istek kapsamı içinse geçerlidir.
scope	string: Single	Avantaj kapsamı. Örneğin, Tek veya Paylaşılan.
subscriptionId	string	Bu tek kapsam önerisinin ilgili olduğu abonelik kimliği. Yalnızca öneri 'Tek' kapsam içinse geçerlidir.
term	term	Avantajın dönem süresi. Örneğin, P1Y veya P3Y.
totalHours	integer	Maliyetin karşılandığı toplam saat. 'properties/usage/charges' özelliğindeki kayıt sayısına eşittir.
usage	recommendationUsageDetails	bilgi işlem avantajı önerileri için kullanılan firstConsumptionDate ile lastConsumptionDate arasındaki isteğe bağlı ücretler.

term

Avantajın dönem süresi. Örneğin, P1Y veya P3Y.

Name	Tür	Description
P1Y	string	Kazanç süresi 1 yıldır.
P3Y	string	Kazanç süresi 3 yıldır.

Share via