Reservations Details - List

Referentie

Service:: Consumption

API-versie:: 2024-08-01

Hier vindt u de reserveringsgegevens voor het opgegeven datumbereik. Opmerking: ARM heeft een maximale nettoladinggrootte van 12 MB, dus op dit moment krijgen bellers 400 wanneer de antwoordgrootte de ARM-limiet overschrijdt. Als de gegevensgrootte te groot is, krijgen klanten mogelijk ook 504 als er een time-out optreedt voor de API bij het voorbereiden van de gegevens. In dergelijke gevallen moet de API-aanroep worden uitgevoerd met kleinere datumbereiken of moet een aanroep voor het rapport-API reserveringsgegevens genereren worden uitgevoerd omdat deze asynchroon is en er geen time-outs optreden voor de reactiegrootte.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01

Met optionele parameters:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2024-08-01

URI-parameters

Name	In	Vereist	Type	Description
resourceScope	path	True	string	Het bereik dat is gekoppeld aan bewerkingen voor reserveringsgegevens. Dit omvat '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het factureringsaccountbereik (verouderd) en /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} voor het factureringsprofiel (modern).
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2023-03-01.
$filter	query		string	Filter reserveringsgegevens op datumbereik. De eigenschappen/UsageDate voor de begin- en einddatum. Het filter ondersteunt 'le' en 'ge'. Niet van toepassing bij het uitvoeren van query's met een factureringsprofiel
endDate	query		string	Einddatum. Alleen van toepassing bij het uitvoeren van query's met een factureringsprofiel
reservationId	query		string	GUID van reserverings-id. Alleen geldig als reservationOrderId ook is opgegeven. Filteren op een specifieke reservering
reservationOrderId	query		string	GUID voor reserveringsorder-id. Vereist als reservationId is opgegeven. Filteren op een specifieke reserveringsorder
startDate	query		string	Begindatum. Alleen van toepassing bij het uitvoeren van query's met een factureringsprofiel

Antwoorden

Name	Type	Description
200 OK	ReservationDetailsListResult	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

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails?$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05&api-version=2024-08-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2017-11-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileId

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&api-version=2024-08-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2024-08-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

Definities

Name	Description
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.
ReservationDetail	resource voor reserveringsgegevens.
ReservationDetailsListResult	Resultaat van het weergeven van reserveringsgegevens.

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.

ReservationDetail

Object

resource voor reserveringsgegevens.

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.instanceFlexibilityGroup	string	De flexibiliteitsgroep van het exemplaar.
properties.instanceFlexibilityRatio	string	De flexibiliteitsverhouding van het exemplaar.
properties.instanceId	string	Deze id is de naam van de resource of de volledig gekwalificeerde resource-id.
properties.kind	string	Het reserveringstype.
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 uren dat voor de dag is gereserveerd. Bijvoorbeeld als de reservering voor 1 instantie om 1 uur is gemaakt, 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)	De datum waarop het verbruik heeft plaatsgevonden.
properties.usedHours	number (decimal)	Dit is het totale aantal uren dat door het exemplaar wordt gebruikt.
tags	object	Resourcetags.
type	string	Resourcetype.

ReservationDetailsListResult

Object

Resultaat van het weergeven van reserveringsgegevens.

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

Delen via

Reservations Details - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ReservationDetailsByBillingAccountId

Voorbeeldaanvraag

Voorbeeldrespons

ReservationDetailsByBillingProfileId

Voorbeeldaanvraag

Voorbeeldrespons

ReservationDetailsByBillingProfileIdReservationId

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

Aanvullende resources