Reservation Recommendation Details - Get

Referencia

Szolgáltatás:: Consumption

API-verzió:: 2023-05-01

A fenntartott példányok lehetőségelemzésére vonatkozó foglalási javaslat részletei.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceScope	path	True	string	A foglalási javaslat részleteinek műveleteihez társított hatókör. Ide tartozik a "/subscriptions/{subscriptionId}/" az előfizetés hatóköréhez, a "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" erőforráscsoport-hatókörhöz, a /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a BillingAccount hatókörhöz, valamint a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a billingProfile hatókörhöz
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2023-03-01.
lookBackPeriod	query	True	lookBackPeriod	Szűrje azt az időszakot, amelyen a foglalási javaslatok eredményei alapulnak.
product	query	True	string	Szűrje azokat a termékeket, amelyek esetében a foglalási javaslatok eredményei létrejönnek. Példák: Standard_DS1_v2 (virtuális gépekhez), Premium_SSD_Managed_Disks_P30 (Managed Disks esetén)
region	query	True	string	Annak a régiónak a kiválasztására szolgál, amelynek a javaslatát létre kell készíteni.
scope	query	True	scope	A foglalás hatóköre.
term	query	True	term	Adja meg a foglalási javaslat időtartamának hosszát.
$filter	query		string	A foglalási javaslatok részleteinek szűrésére szolgál a következő szerint: properties/subscriptionId megadható a számlázási fiókhoz és a számlázási profil elérési útjaihoz.

Válaszok

Name	Típus	Description
200 OK	ReservationRecommendationDetailsModel	OK gombra. A kérés sikeres volt.
204 No Content		Ha nincsenek javaslatok részletei, a rendszer üres választ küld.
Other Status Codes	HighCasedErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ReservationRecommendationsByBillingAccount-Legacy

ReservationRecommendationsByBillingProfile-Modern

ReservationRecommendationsByResourceGroup-Legacy

ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 204

ReservationRecommendationsByBillingProfile-Modern

Mintakérelem

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=2023-05-01&scope=Shared&region=australiaeast&term=P1Y&lookBackPeriod=Last7Days&product=Standard_B2s&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 204

ReservationRecommendationsByResourceGroup-Legacy

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 204

ReservationRecommendationsBySubscription-Legacy

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 204

Definíciók

Name	Description
HighCasedErrorDetails	A hiba részletei.
HighCasedErrorResponse	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg. Néhány hibaválasz: 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időre való várakozás után. 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.
lookBackPeriod	Szűrje azt az időszakot, amelyen a foglalási javaslatok eredményei alapulnak.
ReservationRecommendationDetailsCalculatedSavingsProperties	A becsült megtakarítás részletei. A költségek és a megtakarítások becsült értéke az adott időszakra vonatkozóan.
ReservationRecommendationDetailsModel	Foglalási javaslat részletei.
ReservationRecommendationDetailsResourceProperties	Az erőforrás részletei.
ReservationRecommendationDetailsSavingsProperties	A becsült megtakarítás részletei.
ReservationRecommendationDetailsUsageProperties	A javaslat kiszámításához használt korábbi használati adatok részletei.
scope	A foglalás hatóköre.
term	Adja meg a foglalási javaslat időtartamának hosszát.

HighCasedErrorDetails

A hiba részletei.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

HighCasedErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időre való várakozás után.
503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.

Name	Típus	Description
error	HighCasedErrorDetails	A hiba részletei.

lookBackPeriod

Szűrje azt az időszakot, amelyen a foglalási javaslatok eredményei alapulnak.

Name	Típus	Description
Last30Days	string	30 napnyi adat használata javaslatokhoz
Last60Days	string	60 napnyi adat használata javaslatokhoz
Last7Days	string	7 napnyi adat használata javaslatokhoz

ReservationRecommendationDetailsCalculatedSavingsProperties

A becsült megtakarítás részletei. A költségek és a megtakarítások becsült értéke az adott időszakra vonatkozóan.

Name	Típus	Description
onDemandCost	number	Foglalás nélküli költség. Hardver- és szoftverköltségeket tartalmaz.
overageCost	number	A foglalás által nem fedezett erőforrások hardver- és szoftverköltsége.
quantity	number	A számított megtakarítások mennyisége.
reservationCost	number	A foglalás által fedezett erőforrások hardverköltsége.
reservedUnitCount	number	A megtakarítás kiszámításához használt fenntartott egységek száma. Mindig 1 virtuális gépekhez.
savings	number	A javasolt foglalási mennyiség megvásárlásával megtakarított összeg. Ez egyenlő az onDemandCost – totalReservationCost értékekkel.
totalReservationCost	number	Foglalási költség + a foglalás által fedezett erőforrások szoftverköltsége + túlhasználati költség.

ReservationRecommendationDetailsModel

Foglalási javaslat részletei.

Name	Típus	Description
etag	string	Az erőforrás etagje.
id	string	Egy esemény teljes ARM-azonosítója.
location	string	Erőforrás helye.
name	string	Az eseményt egyedileg azonosító azonosító.
properties.currency	string	A költségek és megtakarítások ISO 4217-es pénznemkód-azonosítója
properties.resource	ReservationRecommendationDetailsResourceProperties	Erőforrás-specifikus tulajdonságok.
properties.resourceGroup	string	Erőforráscsoport.
properties.savings	ReservationRecommendationDetailsSavingsProperties	Megtakarítási információk a javaslathoz.
properties.scope	string	A foglalás hatóköre, például: Egyszemélyes vagy Megosztott.
properties.usage	ReservationRecommendationDetailsUsageProperties	A becsült megtakarítás kiszámításához használt korábbi használati adatok.
sku	string	Erőforrás-termékváltozat
tags	object	Erőforráscímkék.
type	string	Erőforrástípus.

ReservationRecommendationDetailsResourceProperties

Az erőforrás részletei.

Name	Típus	Description
appliedScopes	string[]	Azon előfizetések listája, amelyekre a foglalás vonatkozik.
onDemandRate	number	Az erőforrás óránkénti igény szerinti aránya. Csak a hardverhasználati arányt tartalmazza, azaz a szoftverhasználati arányt nem tartalmazza.
product	string	Azure-termék, például: Standard_E8s_v3 stb.
region	string	Azure-erőforrásrégió például: EastUS, WestUS stb.
reservationRate	number	Az erőforrás óránkénti foglalási aránya. A kifejezéstől függően változik.
resourceType	string	Az Azure-erőforrás típusa.

ReservationRecommendationDetailsSavingsProperties

A becsült megtakarítás részletei.

Name	Típus	Description
calculatedSavings	ReservationRecommendationDetailsCalculatedSavingsProperties[]	A számított megtakarítások listája.
lookBackPeriod	integer	A javaslat kiszámításához használt használati napok száma.
recommendedQuantity	number	Az erőforrás ajánlott egységeinek száma.
reservationOrderTerm	string	A foglalás időszaka, például P1Y vagy P3Y.
savingsType	string	A megtakarítás típusa, például: példány.
unitOfMeasure	string	Mértékegység pl. óra stb.

ReservationRecommendationDetailsUsageProperties

A javaslat kiszámításához használt korábbi használati adatok részletei.

Name	Típus	Description
firstConsumptionDate	string	A javaslat kiszámításához használt első használati dátum.
lastConsumptionDate	string	A javaslat kiszámításához használt utolsó használati dátum.
lookBackUnitType	string	Mit jelentenek a használati adatok értékei, például: virtuálisgép-példány.
usageData	number[]	Az előzményerőforrás-használat lebontása. Az értékek az elsőConsumptionDate és a lastConsumptionDate közötti használati sorrendben vannak.
usageGrain	string	A használati adatokban szereplő értékek szemcséje, például: óránként.

scope

A foglalás hatóköre.

Name	Típus	Description
Shared	string
Single	string

term

Adja meg a foglalási javaslat időtartamának hosszát.

Name	Típus	Description
P1Y	string	1 éves foglalási időszak
P3Y	string	3 éves foglalási időszak

Megosztás a következőn keresztül:

Reservation Recommendation Details - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

ReservationRecommendationsByBillingAccount-Legacy

Mintakérelem

Mintaválasz

ReservationRecommendationsByBillingProfile-Modern

Mintakérelem

Mintaválasz

ReservationRecommendationsByResourceGroup-Legacy

Mintakérelem

Mintaválasz

ReservationRecommendationsBySubscription-Legacy

Mintakérelem

Mintaválasz

Definíciók

HighCasedErrorDetails

HighCasedErrorResponse

lookBackPeriod

ReservationRecommendationDetailsCalculatedSavingsProperties

ReservationRecommendationDetailsModel

ReservationRecommendationDetailsResourceProperties

ReservationRecommendationDetailsSavingsProperties

ReservationRecommendationDetailsUsageProperties

scope

term

További források