Reservation Recommendation Details - Get

Odwołanie

Usługa:: Consumption

Wersja interfejsu API:: 2024-08-01

Szczegółowe informacje o rekomendacji dotyczącej rezerwacji na potrzeby analizy warunkowej wystąpień zarezerwowanych.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}

Z parametrami opcjonalnymi:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}&$filter={$filter}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceScope	path	True	string	Zakres skojarzony z operacjami szczegółów zaleceń dotyczących rezerwacji. 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 BillingAccount oraz "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu billingProfile
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2023-03-01.
lookBackPeriod	query	True	lookBackPeriod	Filtruj okres, w którym są oparte wyniki rekomendacji dotyczących rezerwacji.
product	query	True	string	Filtruj produkty, dla których są generowane wyniki rekomendacji dotyczących rezerwacji. Przykłady: Standard_DS1_v2 (dla maszyn wirtualnych), Premium_SSD_Managed_Disks_P30 (dla dysków zarządzanych)
region	query	True	string	Służy do wybierania regionu, dla którego należy wygenerować zalecenie.
scope	query	True	scope	Zakres rezerwacji.
term	query	True	term	Określ długość okresu rekomendacji dotyczącej rezerwacji.
$filter	query		string	Służy do filtrowania szczegółów rekomendacji rezerwacji według: properties/subscriptionId można określić dla konta rozliczeniowego i ścieżek profilu rozliczeniowego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReservationRecommendationDetailsModel	OK. Żądanie zakończyło się pomyślnie.
204 No Content		Pusta odpowiedź jest wysyłana, gdy nie ma żadnych szczegółów rekomendacji.
Other Status Codes	HighCasedErrorResponse	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

ReservationRecommendationsByBillingAccount-Legacy

ReservationRecommendationsByBillingProfile-Modern

ReservationRecommendationsByResourceGroup-Legacy

ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Przykładowe żądanie

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Shared&region=eastus&term=P1Y&lookBackPeriod=Last60Days&product=Standard_DS14_v2&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 1.482,
      "product": "Standard_DS14_v2",
      "region": "eastus",
      "reservationRate": 0.70570776255707,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 529550.326618951,
          "overageCost": 63253.5935111345,
          "quantity": 220,
          "reservationCost": 223102.452054792,
          "totalReservationCost": 286356.045565927,
          "savings": 243194.281053024
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 149335.025050147,
          "quantity": 179,
          "reservationCost": 181524.267808217,
          "totalReservationCost": 330859.292858364,
          "savings": 198691.033760586
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 195942.319606957,
          "quantity": 157,
          "reservationCost": 159214.022602738,
          "totalReservationCost": 355156.342209695,
          "savings": 174393.984409255
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 30975.2311896299,
          "quantity": 241,
          "reservationCost": 244398.595205477,
          "totalReservationCost": 275373.826395107,
          "savings": 254176.500223843
        }
      ],
      "lookBackPeriod": 60,
      "recommendedQuantity": 253,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2019-11-27T00:00:00",
      "lastConsumptionDate": "2020-01-25T21:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        275.95003899999995,
        275.916705,
        276,
        276,
        275.916725,
        275.916705,
        275.98335299999997,
        276,
        276,
        276,
        276,
        276,
        275.98335299999997,
        276,
        276,
        276,
        276,
        275.933352
      ],
      "usageGrain": "hourly"
    }
  }
}

Kod stanu:: 204

ReservationRecommendationsByBillingProfile-Modern

Przykładowe żądanie

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Shared&region=australiaeast&term=P1Y&lookBackPeriod=Last7Days&product=Standard_B2s&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "AUD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.0725,
      "product": "Standard_B2s",
      "region": "australiaeast",
      "reservationRate": 0.04414166531788041,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 632.8844720496894,
          "overageCost": 0,
          "quantity": 1,
          "reservationCost": 387.74038815226174,
          "totalReservationCost": 387.74038815226174,
          "savings": 245.1440838974277
        }
      ],
      "lookBackPeriod": 7,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2020-01-19T00:00:00",
      "lastConsumptionDate": "2020-01-25T17:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        0
      ],
      "usageGrain": "hourly"
    }
  }
}

Kod stanu:: 204

ReservationRecommendationsByResourceGroup-Legacy

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "testGroup"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": "testGroup",
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Kod stanu:: 204

ReservationRecommendationsBySubscription-Legacy

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Kod stanu:: 204

Definicje

Nazwa	Opis
HighCasedErrorDetails	Szczegóły błędu.
HighCasedErrorResponse	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".
lookBackPeriod	Filtruj okres, w którym są oparte wyniki rekomendacji dotyczących rezerwacji.
ReservationRecommendationDetailsCalculatedSavingsProperties	Szczegóły szacowanych oszczędności. Koszty i oszczędności są szacowane na ten okres.
ReservationRecommendationDetailsModel	Szczegóły zaleceń dotyczących rezerwacji.
ReservationRecommendationDetailsResourceProperties	Szczegóły zasobu.
ReservationRecommendationDetailsSavingsProperties	Szczegóły szacowanych oszczędności.
ReservationRecommendationDetailsUsageProperties	Szczegółowe informacje o historycznych danych użycia, które zostały użyte do obliczenia zalecenia.
scope	Zakres rezerwacji.
term	Określ długość okresu rekomendacji dotyczącej rezerwacji.

HighCasedErrorDetails

Objekt

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ę.

HighCasedErrorResponse

Objekt

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	HighCasedErrorDetails	Szczegóły błędu.

lookBackPeriod

Wyliczanie

Filtruj okres, w którym są oparte wyniki rekomendacji dotyczących rezerwacji.

Wartość	Opis
Last30Days	Użyj 30 dni danych dla zaleceń
Last60Days	Użyj 60 dni danych w celu uzyskania zaleceń
Last7Days	Użyj 7 dni danych dla zaleceń

ReservationRecommendationDetailsCalculatedSavingsProperties

Objekt

Szczegóły szacowanych oszczędności. Koszty i oszczędności są szacowane na ten okres.

Nazwa	Typ	Opis
onDemandCost	number	Koszt bez rezerwacji. Obejmuje koszt sprzętu i oprogramowania.
overageCost	number	Koszt sprzętu i oprogramowania zasobów, które nie są objęte rezerwacją.
quantity	number	Ilość obliczonych oszczędności.
reservationCost	number	Koszt sprzętu zasobów objętych rezerwacją.
reservedUnitCount	number	Liczba jednostek zarezerwowanych używanych do obliczania oszczędności. Zawsze 1 dla maszyn wirtualnych.
savings	number	Kwota zapisana przez zakup zalecanej ilości rezerwacji. Jest to równe onDemandCost — totalReservationCost.
totalReservationCost	number	Koszt rezerwacji i koszt oprogramowania zasobów objętych rezerwacją i kosztem nadwyżki.

ReservationRecommendationDetailsModel

Objekt

Szczegóły zaleceń dotyczących rezerwacji.

Nazwa	Typ	Opis
etag	string	Element etag zasobu.
id	string	Pełny kwalifikowany identyfikator arm zdarzenia.
location	string	Lokalizacja zasobu.
name	string	Identyfikator, który jednoznacznie identyfikuje zdarzenie.
properties.currency	string	Identyfikator kodu waluty ISO 4217 dla kosztów i oszczędności
properties.resource	ReservationRecommendationDetailsResourceProperties	Właściwości specyficzne dla zasobu.
properties.resourceGroup	string	Grupa zasobów.
properties.savings	ReservationRecommendationDetailsSavingsProperties	Informacje o oszczędnościach dla zalecenia.
properties.scope	string	Zakres rezerwacji, np. pojedynczy lub udostępniony.
properties.usage	ReservationRecommendationDetailsUsageProperties	Historyczne szczegóły użycia używane do obliczania szacowanych oszczędności.
sku	string	Jednostka SKU zasobu
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ReservationRecommendationDetailsResourceProperties

Objekt

Szczegóły zasobu.

Nazwa	Typ	Opis
appliedScopes	string[]	Lista subskrypcji, dla których jest stosowana rezerwacja.
onDemandRate	number	Stawka godzinowa zasobu na żądanie. Obejmuje tylko szybkość sprzętu, tj. szybkość oprogramowania nie jest uwzględniana.
product	string	Produkt platformy Azure: Standard_E8s_v3 itp.
region	string	Region zasobów platformy Azure ex:EastUS, WestUS itp.
reservationRate	number	Stawka za rezerwację godzinową zasobu. Różni się w zależności od terminu.
resourceType	string	Typ zasobu platformy Azure.

ReservationRecommendationDetailsSavingsProperties

Objekt

Szczegóły szacowanych oszczędności.

Nazwa	Typ	Opis
calculatedSavings	ReservationRecommendationDetailsCalculatedSavingsProperties[]	Lista obliczonych oszczędności.
lookBackPeriod	integer (int32)	Liczba dni użycia do wyszukania wstecz używanego do obliczania zalecenia.
recommendedQuantity	number	Liczba zalecanych jednostek zasobu.
reservationOrderTerm	string	Okres rezerwacji. np. P1M, P1Y lub P3Y.
savingsType	string	Typ oszczędności, np. wystąpienie.
unitOfMeasure	string	Jednostka miary ex: godzina itp.

ReservationRecommendationDetailsUsageProperties

Objekt

Szczegółowe informacje o historycznych danych użycia, które zostały użyte do obliczenia zalecenia.

Nazwa	Typ	Opis
firstConsumptionDate	string	Pierwsza data użycia użyta do wyszukania w celu obliczenia zalecenia.
lastConsumptionDate	string	Ostatnia data użycia użyta do wyszukania w celu obliczenia zalecenia.
lookBackUnitType	string	Jakie wartości danych użycia reprezentują na przykład: wystąpienie maszyny wirtualnej.
usageData	number[]	Podział historycznych użycia zasobów. Wartości są w kolejności użycia między wartościami firstConsumptionDate i lastConsumptionDate.
usageGrain	string	Ziarno wartości reprezentowanych w danych użycia, np. godzinowo.

scope

Wyliczanie

Zakres rezerwacji.

Wartość	Opis
Shared
Single

term

Wyliczanie

Określ długość okresu rekomendacji dotyczącej rezerwacji.

Wartość	Opis
P1M	Okres rezerwacji w 1 miesiącu
P1Y	Okres rezerwacji 1 roku
P3Y	3-letni okres rezerwacji

Udostępnij za pośrednictwem

Reservation Recommendation Details - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ReservationRecommendationsByBillingAccount-Legacy

Przykładowe żądanie

Przykładowa odpowiedź

ReservationRecommendationsByBillingProfile-Modern

Przykładowe żądanie

Przykładowa odpowiedź

ReservationRecommendationsByResourceGroup-Legacy

Przykładowe żądanie

Przykładowa odpowiedź

ReservationRecommendationsBySubscription-Legacy

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

HighCasedErrorDetails

HighCasedErrorResponse

lookBackPeriod

ReservationRecommendationDetailsCalculatedSavingsProperties

ReservationRecommendationDetailsModel

ReservationRecommendationDetailsResourceProperties

ReservationRecommendationDetailsSavingsProperties

ReservationRecommendationDetailsUsageProperties

scope

term

Dodatkowe zasoby