Reservation Recommendation Details - Get

Service:
Consumption
API Version:
2019-10-01

Szczegóły zalecenia dotyczącego rezerwacji dla analizy analizy what-if wystąpień zarezerwowanych.

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

Parametry identyfikatora URI

Name In Required Type Description
billingScope
 path True
  • string

Zakres skojarzony z rekomendacją rezerwacji szczegóły operacji. Obejmuje to "/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, która ma być używana z żądaniem klienta. Bieżąca wersja to 2019-10-01.
lookBackPeriod
 query True

Filtruj okres, na którym są oparte wyniki rekomendacji rezerwacji.
product
 query True
  • string

Filtruj produkty, dla których są generowane wyniki rekomendacji rezerwacji. Przykłady: Standard_DS1_v2 (dla maszyny wirtualnej), Premium_SSD_Managed_Disks_P30 (dla Dyski zarządzane)
region
 query True
  • string

Służy do wybierania regionu, dla który ma zostać wygenerowane zalecenie.
scope
 query True

Zakres rezerwacji.
term
 query True

Określ długość okresu rekomendacji rezerwacji.

Odpowiedzi

Name Type Description
200 OK

OK. Żądanie zakończyło się pomyślnie.
204 No Content

Pusta odpowiedź jest wysyłana, gdy nie ma szczegółów zalecenia.
Other Status Codes

Odpowiedź o błędzie opisująca przyczynę błędu operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2.

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

ReservationRecommendationsByBillingAccount-Legacy
ReservationRecommendationsByBillingProfile-Modern
ReservationRecommendationsByResourceGroup-Legacy
ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2019-10-01&scope=Shared&region=eastus&term=P1Y&lookBackPeriod=Last60Days&product=Standard_DS14_v2

Sample Response

Status code:
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"
    }
  }
}
Status code:
204

ReservationRecommendationsByBillingProfile-Modern

Sample Request

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=2019-10-01&scope=Shared&region=australiaeast&term=P1Y&lookBackPeriod=Last7Days&product=Standard_B2s

Sample Response

Status code:
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.044141665317880413,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 632.88447204968941,
          "overageCost": 0,
          "quantity": 1,
          "reservationCost": 387.74038815226174,
          "totalReservationCost": 387.74038815226174,
          "savings": 245.14408389742769
        }
      ],
      "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"
    }
  }
}
Status code:
204

ReservationRecommendationsByResourceGroup-Legacy

Sample Request

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

Sample Response

Status code:
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.48136020700059,
          "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"
    }
  }
}
Status code:
204

ReservationRecommendationsBySubscription-Legacy

Sample Request

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

Sample Response

Status code:
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.48136020700059,
          "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"
    }
  }
}
Status code:
204

Definicje

HighCasedErrorDetails

Szczegóły błędu.
HighCasedErrorResponse

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

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczone. Ponów próbę po odczekeniu 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 odczekieniu czasu określonego w nagłówku "Ponów po".
lookBackPeriod

Filtruj okres, na którym są oparte wyniki rekomendacji rezerwacji.
ReservationRecommendationDetailsCalculatedSavingsProperties

Szczegóły szacowanych oszczędności.
ReservationRecommendationDetailsModel

Szczegóły zalecenia dotyczącego 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 rezerwacji.

HighCasedErrorDetails

Szczegóły błędu.

Name Type Description
code
  • string

Kod błędu.
message
  • string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

HighCasedErrorResponse

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

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczone. Ponów próbę po odczekeniu 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 odczekieniu czasu określonego w nagłówku "Ponów po".

Name Type Description
error

Szczegóły błędu.

lookBackPeriod

Filtruj okres, na którym są oparte wyniki rekomendacji rezerwacji.

Name Type Description
Last30Days
  • string

Korzystanie z danych z 30 dni w celu korzystania z rekomendacji
Last60Days
  • string

Używanie danych z 60 dni na użytek rekomendacji
Last7Days
  • string

Użyj danych z 7 dni, aby uzyskać rekomendacje

ReservationRecommendationDetailsCalculatedSavingsProperties

Szczegóły szacowanych oszczędności.

Name Type Description
onDemandCost
  • number

Koszt bez rezerwacji.
overageCost
  • number

Różnica między łącznym kosztem rezerwacji a kosztem rezerwacji.
quantity
  • number

Ilość obliczonych oszczędności.
reservationCost
  • number

Dokładny koszt szacowanego użycia przy użyciu rezerwacji.
reservedUnitCount
  • number

Liczba jednostek zarezerwowanych używanych do obliczania oszczędności. Zawsze 1 dla maszyn wirtualnych.
savings
  • number

Kwota zaoszczędzana przez zakup zalecanej ilości rezerwacji.
totalReservationCost
  • number

Koszt sugerowanej ilości.

ReservationRecommendationDetailsModel

Szczegóły zalecenia dotyczącego rezerwacji.

Name Type Description
eTag
  • string

Zasób eTag.
etag
  • string

Tag etag zasobu.
id
  • string

Identyfikator zasobu.
location
  • string

Lokalizacja zasobu.
name
  • string

Nazwa zasobu.
properties.currency
  • string

Identyfikator kodu waluty ISO 4217 dla kosztów i oszczędności
properties.resource

Właściwości specyficzne dla zasobu.
properties.resourceGroup
  • string

Grupa zasobów.
properties.savings

Informacje o oszczędnościach dla zalecenia.
properties.scope
  • string

Zakres rezerwacji, np. Pojedynczy lub Udostępniony.
properties.usage

Historyczne szczegóły użycia używane do obliczania szacowanych oszczędności.
sku
  • string

Zasób sku
tags
  • object

Tagi zasobów.
type
  • string

Typ zasobu.

ReservationRecommendationDetailsResourceProperties

Szczegóły zasobu.

Name Type Description
appliedScopes
  • string[]

Lista subskrypcji, dla których jest stosowana rezerwacja.
onDemandRate
  • number

Na wskaźnik zapotrzebowania zasobu.
product
  • string

Produkt platformy Azure, na przykład Standard_E8s_v3 itp.
region
  • string

Region zasobów platformy Azure, np.EastUS, WestUS itp.
reservationRate
  • number

Stawka rezerwacji zasobu.
resourceType
  • string

Typ zasobu platformy Azure.

ReservationRecommendationDetailsSavingsProperties

Szczegóły szacowanych oszczędności.

Name Type Description
calculatedSavings

Lista obliczonych oszczędności.
lookBackPeriod
  • integer

Liczba dni użycia używanych do przetwarzania rekomendacji.
recommendedQuantity
  • number

Liczba zalecanych jednostek zasobu.
reservationOrderTerm
  • string

Okres rezerwacji, np. P1Y lub P3Y.
savingsType
  • string

Typ oszczędności, np. wystąpienie.
unitOfMeasure
  • string

Jednostka miary, np.: godzina itp.

ReservationRecommendationDetailsUsageProperties

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

Name Type Description
firstConsumptionDate
  • string

Pierwsza data użycia używana do przetwarzania rekomendacji.
lastConsumptionDate
  • string

Data ostatniego użycia używana do zaglądania do przetwarzania zalecenia.
lookBackUnitType
  • string

Co reprezentują wartości danych użycia, na przykład: wystąpienie maszyny wirtualnej.
usageData
  • number[]

Podział historycznego 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, na przykład: co godzinę.

scope

Zakres rezerwacji.

Name Type Description
Shared
  • string
Single
  • string

term

Określ długość okresu rekomendacji rezerwacji.

Name Type Description
P1Y
  • string

1-letni okres rezerwacji
P3Y
  • string

3-letni okres rezerwacji