Reservations Summaries - List By Reservation Order And Reservation

Referentie

Service:: Consumption

API-versie:: 2024-08-01

Hier vindt u een overzicht van de reserveringen voor dagelijks of maandelijks korrels. Opmerking: ARM heeft een maximale nettoladinggrootte van 12 MB, dus op dit moment krijgen bellers 400 wanneer de antwoordgrootte de ARM-limiet overschrijdt. In dergelijke gevallen moet de API-aanroep worden uitgevoerd met kleinere datumbereiken.

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01

Met optionele parameters:

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&$filter={$filter}&api-version=2024-08-01

URI-parameters

Name	In	Vereist	Type	Description
reservationId	path	True	string	Id van de reservering
reservationOrderId	path	True	string	Order-id van de reservering
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2023-03-01.
grain	query	True	datagrain	Kan dagelijks of maandelijks zijn
$filter	query		string	Alleen vereist voor dagelijks graan. De eigenschappen/UsageDate voor de begin- en einddatum. Het filter ondersteunt 'le' en 'ge'

Antwoorden

Name	Type	Description
200 OK	ReservationSummariesListResult	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

Definities

Name	Description
datagrain	Kan dagelijks of maandelijks zijn
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'. Time-out van 504 gateway: er is een time-out opgetreden voor de service tijdens het verwerken van de aanvraag. Verminder indien mogelijk het datumbereik in de aanvraag.
ReservationSummariesListResult	Resultaat van het weergeven van reserveringsoverzichten.
ReservationSummary	resource voor reserveringsoverzicht.

datagrain

Inventarisatie

Kan dagelijks of maandelijks zijn

Waarde	Description
daily	Dagelijks gegevenskorrels
monthly	Maandelijkse gegevenskorrel

ErrorDetails

Object

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Object

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
Time-out van 504 gateway: er is een time-out opgetreden voor de service tijdens het verwerken van de aanvraag. Verminder indien mogelijk het datumbereik in de aanvraag.

Name	Type	Description
error	ErrorDetails	De details van de fout.

ReservationSummariesListResult

Object

Resultaat van het weergeven van reserveringsoverzichten.

Name	Type	Description
nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
value	ReservationSummary[]	De lijst met reserveringsoverzichten.

ReservationSummary

Object

resource voor reserveringsoverzicht.

Name	Type	Description
etag	string	De etag voor de resource.
id	string	De volledig gekwalificeerde ARM-id van een gebeurtenis.
name	string	De id waarmee een gebeurtenis uniek wordt geïdentificeerd.
properties.avgUtilizationPercentage	number (decimal)	Dit is het gemiddelde gebruik voor het hele tijdsbereik. (dag of maand, afhankelijk van het graan)
properties.kind	string	Het reserveringstype.
properties.maxUtilizationPercentage	number (decimal)	Dit is het maximale gebruik per uur in de gebruikstijd (dag of maand). Als de gebruiksrecord bijvoorbeeld overeenkomt met 10-10-10-2017 en op dat voor uur 4 en 5, was het gebruik 100%, retourneert dit veld 100% voor die dag.
properties.minUtilizationPercentage	number (decimal)	Dit is het minimale gebruik per uur in de gebruikstijd (dag of maand). Als de gebruiksrecord bijvoorbeeld overeenkomt met 12-10-2017 en op dat voor uur 4 en 5, was het gebruik 10%, retourneert dit veld 10% voor die dag
properties.purchasedQuantity	number (decimal)	Dit is de aangeschafte hoeveelheid voor de reservationId.
properties.remainingQuantity	number (decimal)	Dit is de resterende hoeveelheid voor de reservationId.
properties.reservationId	string	De reserverings-id is de id van een reservering binnen een reserveringsorder. Elke reservering is de groepering voor het toepassen van het voordeelbereik en geeft ook het aantal exemplaren aan waarop het reserveringsvoordeel kan worden toegepast.
properties.reservationOrderId	string	De reserveringsorder-id is de id voor een reserveringsaankoop. Elke reserveringsorder-id vertegenwoordigt één aankooptransactie. Een reserveringsorder bevat reserveringen. De reserveringsorder geeft de VM-grootte en -regio voor de reserveringen op.
properties.reservedHours	number (decimal)	Dit is het totale aantal gereserveerde uren. Bijvoorbeeld als de reservering voor 1 instantie is gemaakt om 1 uur, is dit 11 uur voor die dag en 24 uur vanaf volgende dagen
properties.skuName	string	Dit is de NAAM van de ARM-SKU. Het kan worden gebruikt om samen te voegen met het serviceType-veld in aanvullende informatie in gebruiksrecords.
properties.totalReservedQuantity	number (decimal)	Dit is het totale aantal instanties dat is gereserveerd voor de reservationId.
properties.usageDate	string (date-time)	Gegevens die overeenkomen met de gebruiksrecord. Als het gegevensinterval maandelijks is, is dit de eerste dag van de maand.
properties.usedHours	number (decimal)	Totaal aantal gebruikte uren door de reservering
properties.usedQuantity	number (decimal)	Dit is de gebruikte hoeveelheid voor de reservationId.
properties.utilizedPercentage	number (decimal)	Dit is het gebruikte percentage voor de reserverings-id.
tags	object	Resourcetags.
type	string	Resourcetype.

Delen via

Reservations Summaries - List By Reservation Order And Reservation

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ReservationSummariesDailyWithReservationId

Voorbeeldaanvraag

Voorbeeldrespons

ReservationSummariesMonthlyWithReservationId

Voorbeeldaanvraag

Voorbeeldrespons

Definities

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

Aanvullende resources