Freigeben über

Benefit Recommendations - List

  • Referenz
Dienst:
Cost Management
API-Version:
2023-11-01

Liste der Empfehlungen für den Kauf eines Sparplans.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
billingScope
 path True

string

Der Bereich, der mit Leistungsempfehlungsvorgängen verknüpft ist. Dies umfasst "/subscriptions/{subscriptionId}/" für den Abonnementbereich, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für Ressourcengruppenbereich, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für den Enterprise Agreement-Bereich und "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für Abrechnungsprofilbereich.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$expand
 query

string

Kann verwendet werden, um die Eigenschaften zu erweitern: properties/usage, properties/allRecommendationDetails
$filter
 query

string

Kann verwendet werden, um benefitRecommendations nach zu filtern: Eigenschaften/Bereich mit zulässigen Werten ['Single', 'Shared'] und Standardwert 'Shared'; und properties/lookBackPeriod mit zulässigen Werten ['Last7Days', 'Last30Days', 'Last60Days'] und dem Standardwert "Last60Days"; Eigenschaften/Ausdruck mit zulässigen Werten ['P1Y', 'P3Y'] und Standardwert 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby
 query

string

Kann verwendet werden, um die Empfehlungen nach: properties/armSkuName zu bestellen. Für den Sparplan sind die Ergebnisse standardmäßig in Ordnung. Es ist nicht erforderlich, diese Klausel zu verwenden.

Antworten

Name Typ Beschreibung
200 OK

benefitRecommendationsListResult

OK. Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

BenefitRecommendationsBillingAccountList

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
allSavingsBenefitDetails

Details zur Empfehlung des Vorteils.
allSavingsList

Die Liste aller Nutzenempfehlungen mit den Empfehlungsdetails.
benefitKind

Reservierung oder Sparplan.
benefitRecommendationModel

Details zur Empfehlung des Leistungsplans.
benefitRecommendationsListResult

Ergebnis der Auflistung von Leistungsempfehlungen.
ErrorDetails

Die Details des Fehlers.
ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.
grain

Das Körnchen der Verwendung. Unterstützte Werte: "Stündlich"
lookBackPeriod

Die Anzahl der Tage der Nutzung, die zum Berechnen der Empfehlungen ausgewertet wird.
recommendationUsageDetails

Bedarfsgesteuerte Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die zum Berechnen von Nutzenempfehlungen verwendet wurden.
sharedScopeBenefitRecommendationProperties

Die Eigenschaften der Vorteilsempfehlung, wenn der Bereich "Shared" lautet.
singleScopeBenefitRecommendationProperties

Die Eigenschaften der Leistungsempfehlungen, wenn der Bereich "Single" ist.
term

Laufzeit der Leistung. Beispiel: P1Y oder P3Y.

allSavingsBenefitDetails

Details zur Empfehlung des Vorteils.

Name Typ Beschreibung
averageUtilizationPercentage

number

Geschätzter durchschnittlicher Auslastungsprozentsatz für "totalHours" im Rückblickzeitraum mit dieser Verpflichtung.
benefitCost

number

Die geschätzten Kosten mit Nutzen für die "totalHours" im Rückblickzeitraum. Sie ist gleich (commitmentAmount * totalHours)
commitmentAmount

number

Der Verpflichtungsbetrag bei der VerpflichtungGranularität.
coveragePercentage

number

Geschätzter Prozentsatz der Leistungsabdeckung für den "totalHours" im Rückblickzeitraum, mit dieser Verpflichtung.
overageCost

number

Die Differenz zwischen Gesamtkosten und Nutzenkosten für den "totalHours" im Rückblickzeitraum.
savingsAmount

number

Der betrag, der für den "totalHours" im Rückblickzeitraum durch Erwerb der empfohlenen Menge des Vorteils eingespart wurde.
savingsPercentage

number

Die Einsparungen in Prozent für den "totalHours" im Rückblickzeitraum durch den Erwerb der empfohlenen Menge des Vorteils.
totalCost

number

Gesamtkosten, d. h. die Summe der Leistungskosten und der Überschreitungskosten.
wastageCost

number

Geschätzter nicht verwendeter Teil des "BenefitCost".

allSavingsList

Die Liste aller Nutzenempfehlungen mit den Empfehlungsdetails.

Name Typ Beschreibung
nextLink

string

Der Link (URL) zur nächsten Seite der Ergebnisse.
value

allSavingsBenefitDetails[]

Die Liste der Nutzenempfehlungen mit den Empfehlungsdetails.

benefitKind

Reservierung oder Sparplan.

Name Typ Beschreibung
IncludedQuantity

string

Der Vorteil ist "IncludedQuantity".
Reservation

string

Der Vorteil ist "Reservierung".
SavingsPlan

string

Vorteil ist SavingsPlan.

benefitRecommendationModel

Details zur Empfehlung des Leistungsplans.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

benefitKind

Reservierung oder Sparplan.
name

string

Der Name der Ressource
properties benefitRecommendationProperties:

Die Eigenschaften der Nutzenempfehlungen.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Ergebnis der Auflistung von Leistungsempfehlungen.

Name Typ Beschreibung
nextLink

string

Der Link (URL) zur nächsten Seite der Ergebnisse.
value

benefitRecommendationModel[]

Die Liste der Nutzenempfehlungen.

ErrorDetails

Die Details des Fehlers.

Name Typ Beschreibung
code

string

Fehlercode
message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

Name Typ Beschreibung
error

ErrorDetails

Die Details des Fehlers.

grain

Das Körnchen der Verwendung. Unterstützte Werte: "Stündlich"

Name Typ Beschreibung
Daily

string

Stündliche Körnung entspricht dem Wert pro Tag.
Hourly

string

Stündliche Körnung entspricht dem Wert pro Stunde.
Monthly

string

Das stündliche Körnung entspricht dem Wert pro Monat.

lookBackPeriod

Die Anzahl der Tage der Nutzung, die zum Berechnen der Empfehlungen ausgewertet wird.

Name Typ Beschreibung
Last30Days

string

30 Tage, um zurückzublicken.
Last60Days

string

60 Tage, um zurückzublicken.
Last7Days

string

7 Tage, um zurückzublicken.

recommendationUsageDetails

Bedarfsgesteuerte Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die zum Berechnen von Nutzenempfehlungen verwendet wurden.

Name Typ Beschreibung
charges

number[]

Bedarfsgesteuerte Gebühren für jede Stunde zwischen firstConsumptionDate und lastConsumptionDate, die zum Berechnen von Nutzenempfehlungen verwendet wurden.
usageGrain

grain

Das Körnchen der Verwendung. Unterstützte Werte: "Stündlich"

sharedScopeBenefitRecommendationProperties

Die Eigenschaften der Vorteilsempfehlung, wenn der Bereich "Shared" lautet.

Name Typ Beschreibung
allRecommendationDetails

allSavingsList

Die Liste aller Nutzenempfehlungen mit den Empfehlungsdetails.
armSkuName

string

ARM-SKU-Name. "Compute_Savings_Plan" für SavingsPlan.
commitmentGranularity

grain

Körnung des vorgeschlagenen Verpflichtungsbetrags. Unterstützte Werte: "Stündlich"
costWithoutBenefit

number

Die aktuellen Kosten ohne Nutzen entsprechen "totalHours" im Rückblickzeitraum.
currencyCode

string

Ein ISO 4217-Währungscodebezeichner für die Kosten und Einsparungen.
firstConsumptionDate

string

Das erste Nutzungsdatum, das für die Rückschau zum Berechnen der Empfehlungen verwendet wird.
lastConsumptionDate

string

Das letzte Nutzungsdatum, das für die Rückschau zum Berechnen der Empfehlungen verwendet wurde.
lookBackPeriod

lookBackPeriod

Die Anzahl der Tage der Nutzung, die zum Berechnen der Empfehlungen ausgewertet wird.
recommendationDetails

allSavingsBenefitDetails

Die Einzelheiten der vorgeschlagenen Empfehlung.
scope string:

Shared

Leistungsbereich. Beispiel: Single oder Shared.
term

term

Laufzeit der Leistung. Beispiel: P1Y oder P3Y.
totalHours

integer

Die Gesamtstunden, für die die Kosten gedeckt sind. Dies entspricht der Anzahl der Datensätze in einer Eigenschaft "properties/usage/charges".
usage

recommendationUsageDetails

Bedarfsgesteuerte Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die zum Berechnen von Nutzenempfehlungen verwendet wurden.

singleScopeBenefitRecommendationProperties

Die Eigenschaften der Leistungsempfehlungen, wenn der Bereich "Single" ist.

Name Typ Beschreibung
allRecommendationDetails

allSavingsList

Die Liste aller Nutzenempfehlungen mit den Empfehlungsdetails.
armSkuName

string

ARM-SKU-Name. "Compute_Savings_Plan" für SavingsPlan.
commitmentGranularity

grain

Körnung des vorgeschlagenen Verpflichtungsbetrags. Unterstützte Werte: "Stündlich"
costWithoutBenefit

number

Die aktuellen Kosten ohne Nutzen entsprechen "totalHours" im Rückblickzeitraum.
currencyCode

string

Ein ISO 4217-Währungscodebezeichner für die Kosten und Einsparungen.
firstConsumptionDate

string

Das erste Nutzungsdatum, das für die Rückschau zum Berechnen der Empfehlungen verwendet wird.
lastConsumptionDate

string

Das letzte Nutzungsdatum, das für die Rückschau zum Berechnen der Empfehlungen verwendet wurde.
lookBackPeriod

lookBackPeriod

Die Anzahl der Tage der Nutzung, die zum Berechnen der Empfehlungen ausgewertet wird.
recommendationDetails

allSavingsBenefitDetails

Die Einzelheiten der vorgeschlagenen Empfehlung.
resourceGroup

string

Die Ressourcengruppe, für die diese einzelne Bereichsempfehlung gilt. Gilt nur, wenn die Empfehlung für den Bereich "Single" und den Anforderungsbereich "ResourceGroup" gilt.
scope string:

Single

Leistungsbereich. Beispiel: Single oder Shared.
subscriptionId

string

Die Abonnement-ID, für die diese einzelne Bereichsempfehlung gilt. Gilt nur, wenn die Empfehlung für den Bereich "Single" gilt.
term

term

Laufzeit der Leistung. Beispiel: P1Y oder P3Y.
totalHours

integer

Die Gesamtstunden, für die die Kosten gedeckt sind. Dies entspricht der Anzahl der Datensätze in einer Eigenschaft "properties/usage/charges".
usage

recommendationUsageDetails

Bedarfsgesteuerte Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die zum Berechnen von Nutzenempfehlungen verwendet wurden.

term

Laufzeit der Leistung. Beispiel: P1Y oder P3Y.

Name Typ Beschreibung
P1Y

string

Die Leistungslaufzeit beträgt 1 Jahr.
P3Y

string

Die Leistungslaufzeit beträgt 3 Jahre.