Benefit Recommendations - List

Odwołanie

Usługa:: Cost Management

Wersja interfejsu API:: 2024-08-01

Lista zaleceń dotyczących zakupu planu oszczędnościowego.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingScope	path	True	string	Zakres skojarzony z operacjami rekomendacji dotyczących korzyści. Obejmuje to ciąg "/subscriptions/{subscriptionId}/" dla zakresu subskrypcji, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu grupy zasobów, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu umowy Enterprise Agreement oraz "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu profilu rozliczeniowego
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Może służyć do rozszerzania właściwości przez: properties/usage, properties/allRecommendationDetails
$filter	query		string	Można użyć do filtrowania benefitRecommendations według: properties/scope z dozwolonymi wartościami ["Single", "Shared" i wartością domyślną "Shared"; i properties/lookBackPeriod z dozwolonymi wartościami ['Last7Days', 'Last30Days', 'Last60Days'] i wartością domyślną "Last60Days"; properties/term z dozwolonymi wartościami ['P1Y', 'P3Y'] i wartością domyślną "P3Y"; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Może służyć do zamawiania zaleceń przez: properties/armSkuName. W przypadku planu oszczędności wyniki są domyślnie uporządkowane. Nie ma potrzeby używania tej klauzuli.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	benefitRecommendationsListResult	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

BenefitRecommendationsBillingAccountList

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
            }
          ]
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
allSavingsBenefitDetails	Szczegóły rekomendacji dotyczącej korzyści.
allSavingsList	Lista wszystkich zaleceń dotyczących korzyści ze szczegółami rekomendacji.
benefitKind	Rezerwacja lub plan oszczędnościowy.
benefitRecommendationModel	szczegóły zaleceń dotyczących planu korzyści.
benefitRecommendationsListResult	Wynik wyświetlania rekomendacji dotyczących korzyści.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy: 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".
grain	Ziarno użycia. Obsługiwane wartości: "Hourly"
lookBackPeriod	Liczba dni użycia obliczonych na potrzeby obliczania zaleceń.
recommendationUsageDetails	Opłaty na żądanie między firstConsumptionDate i lastConsumptionDate, które były używane na potrzeby zaleceń dotyczących korzyści obliczeniowych.
sharedScopeBenefitRecommendationProperties	Właściwości zalecenia dotyczącego korzyści, gdy zakres to "Udostępnione".
singleScopeBenefitRecommendationProperties	Właściwości zaleceń dotyczących korzyści, gdy zakres to "Pojedynczy".
term	Okres świadczenia. Na przykład P1Y lub P3Y.

allSavingsBenefitDetails

Szczegóły rekomendacji dotyczącej korzyści.

Nazwa	Typ	Opis
averageUtilizationPercentage	number	Szacowany średni procent wykorzystania dla wartości "totalHours" w okresie wyszukiwania z tym zobowiązaniem.
benefitCost	number	Szacowany koszt z korzyścią dla wartości "totalHours" w okresie wyszukiwania. Jest równa (commitmentAmount * totalHours)
commitmentAmount	number	Kwota zobowiązania w ramach zobowiązaniaGranularity.
coveragePercentage	number	Szacowany procent pokrycia korzyści dla wartości "totalHours" w okresie wyszukiwania z tym zobowiązaniem.
overageCost	number	Różnica między łącznym kosztem a kosztem korzyści dla wartości "totalHours" w okresie wyszukiwania.
savingsAmount	number	Kwota zapisana dla wartości "totalHours" w okresie wyszukiwania, kupując zalecaną ilość korzyści.
savingsPercentage	number	Oszczędności procentowe dla "totalHours" w okresie wyszukiwania, kupując zalecaną ilość korzyści.
totalCost	number	Całkowity koszt, który jest sumą kosztów korzyści i kosztów nadwyżkowych.
wastageCost	number	Szacowana nieużywana część "benefitCost".

allSavingsList

Lista wszystkich zaleceń dotyczących korzyści ze szczegółami rekomendacji.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	allSavingsBenefitDetails[]	Lista zaleceń dotyczących korzyści ze szczegółami rekomendacji.

benefitKind

Rezerwacja lub plan oszczędnościowy.

Nazwa	Typ	Opis
IncludedQuantity	string	Korzyść jest uwzględnionaQuantity.
Reservation	string	Korzyść to Rezerwacja.
SavingsPlan	string	Korzyść to OszczędnościPlan.

benefitRecommendationModel

szczegóły zaleceń dotyczących planu korzyści.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Rezerwacja lub plan oszczędnościowy.
name	string	Nazwa zasobu
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Właściwości zaleceń dotyczących korzyści.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Wynik wyświetlania rekomendacji dotyczących korzyści.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	benefitRecommendationModel[]	Lista zaleceń dotyczących korzyści.

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

grain

Ziarno użycia. Obsługiwane wartości: "Hourly"

Nazwa	Typ	Opis
Daily	string	Ziarno godzinowe odpowiada wartości na dzień.
Hourly	string	Ziarno godzinowe odpowiada wartości na godzinę.
Monthly	string	Ziarno godzinowe odpowiada wartości na miesiąc.

lookBackPeriod

Liczba dni użycia obliczonych na potrzeby obliczania zaleceń.

Nazwa	Typ	Opis
Last30Days	string	30 dni używanych do spojrzenia wstecz.
Last60Days	string	60 dni używanych do spojrzenia wstecz.
Last7Days	string	7 dni używane do spojrzenia wstecz.

recommendationUsageDetails

Opłaty na żądanie między firstConsumptionDate i lastConsumptionDate, które były używane na potrzeby zaleceń dotyczących korzyści obliczeniowych.

Nazwa	Typ	Opis
charges	number[]	Opłaty na żądanie za każdą godzinę między firstConsumptionDate a lastConsumptionDate, które były używane na potrzeby zaleceń dotyczących korzyści obliczeniowych.
usageGrain	grain	Ziarno użycia. Obsługiwane wartości: "Hourly"

sharedScopeBenefitRecommendationProperties

Właściwości zalecenia dotyczącego korzyści, gdy zakres to "Udostępnione".

Nazwa	Typ	Opis
allRecommendationDetails	allSavingsList	Lista wszystkich zaleceń dotyczących korzyści ze szczegółami rekomendacji.
armSkuName	string	Nazwa jednostki SKU usługi ARM. "Compute_Savings_Plan" dla programu SavingsPlan.
commitmentGranularity	grain	Ziarno proponowanej kwoty zobowiązania. Obsługiwane wartości: "Hourly"
costWithoutBenefit	number	Bieżący koszt bez korzyści odpowiada wartościom "totalHours" w okresie wyszukiwania.
currencyCode	string	Identyfikator kodu waluty ISO 4217 dla kosztów i kwot oszczędności.
firstConsumptionDate	string	Pierwsza data użycia użyta do wyszukania zaleceń dotyczących obliczeń.
lastConsumptionDate	string	Ostatnia data użycia użyta do wyszukania wskazówek dotyczących przetwarzania zaleceń.
lookBackPeriod	lookBackPeriod	Liczba dni użycia obliczonych na potrzeby obliczania zaleceń.
recommendationDetails	allSavingsBenefitDetails	Szczegóły proponowanego zalecenia.
scope	string: Shared	Zakres korzyści. Na przykład pojedynczy lub udostępniony.
term	term	Okres świadczenia. Na przykład P1Y lub P3Y.
totalHours	integer	Łączna liczba godzin, dla których koszty są pokrywane. Jest równa liczbie rekordów we właściwości "properties/usage/charges".
usage	recommendationUsageDetails	Opłaty na żądanie między firstConsumptionDate i lastConsumptionDate, które były używane na potrzeby zaleceń dotyczących korzyści obliczeniowych.

singleScopeBenefitRecommendationProperties

Właściwości zaleceń dotyczących korzyści, gdy zakres to "Pojedynczy".

Nazwa	Typ	Opis
allRecommendationDetails	allSavingsList	Lista wszystkich zaleceń dotyczących korzyści ze szczegółami rekomendacji.
armSkuName	string	Nazwa jednostki SKU usługi ARM. "Compute_Savings_Plan" dla programu SavingsPlan.
commitmentGranularity	grain	Ziarno proponowanej kwoty zobowiązania. Obsługiwane wartości: "Hourly"
costWithoutBenefit	number	Bieżący koszt bez korzyści odpowiada wartościom "totalHours" w okresie wyszukiwania.
currencyCode	string	Identyfikator kodu waluty ISO 4217 dla kosztów i kwot oszczędności.
firstConsumptionDate	string	Pierwsza data użycia użyta do wyszukania zaleceń dotyczących obliczeń.
lastConsumptionDate	string	Ostatnia data użycia użyta do wyszukania wskazówek dotyczących przetwarzania zaleceń.
lookBackPeriod	lookBackPeriod	Liczba dni użycia obliczonych na potrzeby obliczania zaleceń.
recommendationDetails	allSavingsBenefitDetails	Szczegóły proponowanego zalecenia.
resourceGroup	string	Grupa zasobów, dla którego jest zalecane użycie tego pojedynczego zakresu. Dotyczy tylko wtedy, gdy zalecenie dotyczy zakresu żądania "Single" i "ResourceGroup".
scope	string: Single	Zakres korzyści. Na przykład pojedynczy lub udostępniony.
subscriptionId	string	Identyfikator subskrypcji, dla którego jest przeznaczone to zalecenie dotyczące pojedynczego zakresu. Dotyczy tylko wtedy, gdy zalecenie dotyczy zakresu "Pojedynczy".
term	term	Okres świadczenia. Na przykład P1Y lub P3Y.
totalHours	integer	Łączna liczba godzin, dla których koszty są pokrywane. Jest równa liczbie rekordów we właściwości "properties/usage/charges".
usage	recommendationUsageDetails	Opłaty na żądanie między firstConsumptionDate i lastConsumptionDate, które były używane na potrzeby zaleceń dotyczących korzyści obliczeniowych.

term

Okres świadczenia. Na przykład P1Y lub P3Y.

Nazwa	Typ	Opis
P1Y	string	Okres świadczenia wynosi 1 rok.
P3Y	string	Okres świadczenia wynosi 3 lata.

Udostępnij za pośrednictwem