Freigeben über

Benefit Recommendations - List

  • Referenz
Dienst:
Cost Management
API-Version:
2024-08-01

Liste der Empfehlungen für den Kaufsparplan.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
billingScope
 path True

string

Der Umfang, der den Leistungsempfehlungsvorgängen zugeordnet ist. Dies umfasst '/subscriptions/{subscriptionId}/' für den Abonnementbereich, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für den Ressourcengruppenbereich, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' für den Enterprise-Vertragsbereich und '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' für den Abrechnungsprofilbereich.
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand
 query

string

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

string

Kann verwendet werden, um BenefitRecommendations nach: Eigenschaften/Bereich mit zulässigen Werten ['Single', 'Shared'] und Standardwert 'Shared'; und eigenschaften/lookBackPeriod mit zulässigen Werten ['Last7Days', 'Last30Days', 'Last60Days'] und 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. Diese Klausel muss nicht verwendet werden.

Antworten

Name Typ Beschreibung
200 OK

benefitRecommendationsListResult

OKAY. Die Anforderung ist erfolgreich.
Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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=2024-08-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 Leistungsempfehlung.
allSavingsList

Die Liste aller Leistungsempfehlungen mit den Empfehlungsdetails.
benefitKind

Reservierung oder Sparplan.
benefitRecommendationModel

Details zur Empfehlung des Leistungsplans.
benefitRecommendationsListResult

Ergebnis der Auflistung von Vorteilsempfehlungen.
ErrorDetails

Die Details des Fehlers.
ErrorResponse

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

Einige Fehlerantworten:

  • 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
grain

Das Korn der Nutzung. Unterstützte Werte: "Stündlich"
lookBackPeriod

Die Anzahl der Tage der Nutzung, die für die Berechnung der Empfehlungen ausgewertet werden.
recommendationUsageDetails

On-Demand-Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die für die Berechnung von Leistungsempfehlungen verwendet wurden.
sharedScopeBenefitRecommendationProperties

Die Eigenschaften der Vorteilsempfehlung, wenn der Bereich "Freigegeben" ist.
singleScopeBenefitRecommendationProperties

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

Laufzeit des Leistungszeitraums. Beispiel: P1Y oder P3Y.

allSavingsBenefitDetails

Details zur Leistungsempfehlung.

Name Typ Beschreibung
averageUtilizationPercentage

number

Geschätzter durchschnittlicher Auslastungsprozentsatz für die "totalHours" im Nachschlagezeitraum mit diesem Engagement.
benefitCost

number

Die geschätzten Kosten mit Nutzen für die "totalHours" in der Nachschlageperiode. Es ist gleich (commitmentAmount * totalHours)
commitmentAmount

number

Der Verpflichtungsbetrag bei der CommitmentGranularität.
coveragePercentage

number

Geschätzter Nutzendeckungsanteil für die "totalHours" im Look-Back-Zeitraum, mit diesem Engagement.
overageCost

number

Die Differenz zwischen Gesamtkosten und Leistungskosten für die "totalHours" im Nachschlagezeitraum.
savingsAmount

number

Der für die "totalHours" im Look-Back-Zeitraum gespeicherte Betrag, indem die empfohlene Menge des Vorteils gekauft wird.
savingsPercentage

number

Die Einsparungen in Prozent für die "totalHours" im Nachschlagezeitraum, indem sie die empfohlene Menge an Nutzen erwerben.
totalCost

number

Gesamtkosten, die Summe der Leistungskosten und Überlastungskosten sind.
wastageCost

number

Geschätzter nicht verwendeter Teil des 'benefitCost'.

allSavingsList

Die Liste aller Leistungsempfehlungen mit den Empfehlungsdetails.

Name Typ Beschreibung
nextLink

string

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

allSavingsBenefitDetails[]

Die Liste der Leistungsempfehlungen mit den Empfehlungsdetails..

benefitKind

Reservierung oder Sparplan.

Name Typ Beschreibung
IncludedQuantity

string

Der Vorteil ist inbegriffen.
Reservation

string

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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

benefitKind

Reservierung oder Sparplan.
name

string

Der Name der Ressource
properties benefitRecommendationProperties:

Die Eigenschaften der Leistungsempfehlungen.
type

string

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

benefitRecommendationsListResult

Ergebnis der Auflistung von Vorteilsempfehlungen.

Name Typ Beschreibung
nextLink

string

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

benefitRecommendationModel[]

Die Liste der Leistungsempfehlungen.

ErrorDetails

Die Details des Fehlers.

Name Typ Beschreibung
code

string

Fehlercode.
message

string

Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

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

Einige Fehlerantworten:

  • 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name Typ Beschreibung
error

ErrorDetails

Die Details des Fehlers.

grain

Das Korn der Nutzung. Unterstützte Werte: "Stündlich"

Name Typ Beschreibung
Daily

string

Stundenkorn entspricht dem Wert pro Tag.
Hourly

string

Stundenkorn entspricht dem Wert pro Stunde.
Monthly

string

Stundenkorn entspricht dem Wert pro Monat.

lookBackPeriod

Die Anzahl der Tage der Nutzung, die für die Berechnung der Empfehlungen ausgewertet werden.

Name Typ Beschreibung
Last30Days

string

30 Tage, die zum Zurückschauen verwendet wurden.
Last60Days

string

60 Tage, die zum Zurückschauen verwendet wurden.
Last7Days

string

7 Tage, die zum Zurückschauen verwendet wurden.

recommendationUsageDetails

On-Demand-Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die für die Berechnung von Leistungsempfehlungen verwendet wurden.

Name Typ Beschreibung
charges

number[]

On-Demand-Gebühren für jede Stunde zwischen firstConsumdate und lastConsumptionDate, die für die Berechnung von Leistungsempfehlungen verwendet wurden.
usageGrain

grain

Das Korn der Nutzung. Unterstützte Werte: "Stündlich"

sharedScopeBenefitRecommendationProperties

Die Eigenschaften der Vorteilsempfehlung, wenn der Bereich "Freigegeben" ist.

Name Typ Beschreibung
allRecommendationDetails

allSavingsList

Die Liste aller Leistungsempfehlungen mit den Empfehlungsdetails.
armSkuName

string

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

grain

Korn des vorgeschlagenen Verpflichtungsbetrags. Unterstützte Werte: "Stündlich"
costWithoutBenefit

number

Die aktuellen Kosten ohne Nutzen entsprechen den "totalHours" im Nachschlagezeitraum.
currencyCode

string

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

string

Das erste Verwendungsdatum, das für die Suche nach der Berechnung der Empfehlungen verwendet wird.
lastConsumptionDate

string

Das letzte Verwendungsdatum, das für die Suche nach der Berechnung der Empfehlungen verwendet wird.
lookBackPeriod

lookBackPeriod

Die Anzahl der Tage der Nutzung, die für die Berechnung der Empfehlungen ausgewertet werden.
recommendationDetails

allSavingsBenefitDetails

Die Einzelheiten der vorgeschlagenen Empfehlung.
scope string:

Shared

Leistungsumfang. Beispiel: Single oder Shared.
term

term

Laufzeit des Leistungszeitraums. Beispiel: P1Y oder P3Y.
totalHours

integer

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

recommendationUsageDetails

On-Demand-Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die für die Berechnung von Leistungsempfehlungen verwendet wurden.

singleScopeBenefitRecommendationProperties

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

Name Typ Beschreibung
allRecommendationDetails

allSavingsList

Die Liste aller Leistungsempfehlungen mit den Empfehlungsdetails.
armSkuName

string

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

grain

Korn des vorgeschlagenen Verpflichtungsbetrags. Unterstützte Werte: "Stündlich"
costWithoutBenefit

number

Die aktuellen Kosten ohne Nutzen entsprechen den "totalHours" im Nachschlagezeitraum.
currencyCode

string

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

string

Das erste Verwendungsdatum, das für die Suche nach der Berechnung der Empfehlungen verwendet wird.
lastConsumptionDate

string

Das letzte Verwendungsdatum, das für die Suche nach der Berechnung der Empfehlungen verwendet wird.
lookBackPeriod

lookBackPeriod

Die Anzahl der Tage der Nutzung, die für die Berechnung der Empfehlungen ausgewertet werden.
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

Leistungsumfang. 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 des Leistungszeitraums. Beispiel: P1Y oder P3Y.
totalHours

integer

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

recommendationUsageDetails

On-Demand-Gebühren zwischen firstConsumptionDate und lastConsumptionDate, die für die Berechnung von Leistungsempfehlungen verwendet wurden.

term

Laufzeit des Leistungszeitraums. Beispiel: P1Y oder P3Y.

Name Typ Beschreibung
P1Y

string

Die Leistungslaufzeit beträgt 1 Jahr.
P3Y

string

Die Leistungslaufzeit beträgt 3 Jahre.