Reservations Summaries - List By Reservation Order And Reservation

Referenz

Dienst:: Consumption

API-Version:: 2024-08-01

Listet die Reservierungszusammenfassungen für tägliches oder monatliches Getreide auf. Hinweis: ARM hat eine Nutzlastgröße von 12 MB, sodass derzeit Anrufer 400 erhalten, wenn die Antwortgröße den ARM-Grenzwert überschreitet. In solchen Fällen sollte der API-Aufruf mit kleineren Datumsbereichen erfolgen.

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

Mit optionalen Parametern:

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
reservationId	path	True	string	ID der Reservierung
reservationOrderId	path	True	string	Bestell-ID der Reservierung
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2023-03-01.
grain	query	True	datagrain	Kann täglich oder monatlich sein
$filter	query		string	Nur für tägliches Getreide erforderlich. Die Eigenschaften/UsageDate für Startdatum und Enddatum. Der Filter unterstützt "le" und "ge"

Antworten

Name	Typ	Beschreibung
200 OK	ReservationSummariesListResult	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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
      }
    }
  ]
}

Definitionen

Name	Beschreibung
datagrain	Kann täglich oder monatlich sein
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit. 504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.
ReservationSummariesListResult	Ergebnis der Auflistung von Reservierungszusammenfassungen.
ReservationSummary	Reservierungszusammenfassungsressource.

datagrain

Enumeration

Kann täglich oder monatlich sein

Wert	Beschreibung
daily	Tägliches Datenkorn
monthly	Monatliches Datenkorn

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ReservationSummariesListResult

Objekt

Ergebnis der Auflistung von Reservierungszusammenfassungen.

Name	Typ	Beschreibung
nextLink	string	Der Link (URL) zur nächsten Seite der Ergebnisse.
value	ReservationSummary[]	Die Liste der Reservierungszusammenfassungen.

ReservationSummary

Objekt

Reservierungszusammenfassungsressource.

Name	Typ	Beschreibung
etag	string	Das Etag für die Ressource.
id	string	Die vollständige qualifizierte ARM-ID eines Ereignisses.
name	string	Die ID, die ein Ereignis eindeutig identifiziert.
properties.avgUtilizationPercentage	number (decimal)	Dies ist die durchschnittliche Auslastung für den gesamten Zeitraum. (Tag oder Monat je nach Getreide)
properties.kind	string	Die Reservierungsart.
properties.maxUtilizationPercentage	number (decimal)	Dies ist die maximale Stundenauslastung in der Nutzungszeit (Tag oder Monat). Wenn z. B. der Verwendungseintrag 12.10.2017 entspricht und für die Stunde 4 und 5, betrug die Auslastung 100%, gibt dieses Feld 100% für diesen Tag zurück.
properties.minUtilizationPercentage	number (decimal)	Dies ist die minimale Stundenauslastung in der Nutzungszeit (Tag oder Monat). Wenn der Verwendungsdatensatz z. B. dem 12.10.2017 entspricht und für die Stunde 4 und 5, betrug die Auslastung 10%, gibt dieses Feld 10% für diesen Tag zurück.
properties.purchasedQuantity	number (decimal)	Dies ist die erworbene Menge für die reservierungs-ID.
properties.remainingQuantity	number (decimal)	Dies ist die verbleibende Menge für die reservierungs-ID.
properties.reservationId	string	Die Reservierungs-ID ist der Bezeichner einer Reservierung innerhalb eines Reservierungsauftrags. Jede Reservierung ist die Gruppierung für die Anwendung des Leistungsumfangs und gibt auch die Anzahl der Instanzen an, auf die der Reservierungsvorteil angewendet werden kann.
properties.reservationOrderId	string	Die Reservierungsauftrags-ID ist der Bezeichner für einen Reservierungskauf. Jede Reservierungsauftrags-ID stellt eine einzelne Kauftransaktion dar. Eine Reservierungsbestellung enthält Reservierungen. Die Reservierungsreihenfolge gibt die Größe und Region des virtuellen Computers für die Reservierungen an.
properties.reservedHours	number (decimal)	Dies ist die Gesamtzahl der reservierten Stunden. Wenn z. B. eine Reservierung für 1 Instanz am 1:00 Uhr erfolgt ist, beträgt dies 11 Stunden für diesen Tag und 24 Stunden ab nachfolgenden Tagen
properties.skuName	string	Dies ist der ARM-Sku-Name. Sie kann verwendet werden, um mit dem ServiceType-Feld in zusätzlichen Informationen in Verwendungsdatensätzen zu verbinden.
properties.totalReservedQuantity	number (decimal)	Dies ist die Gesamtanzahl der Instanzen, die für die reservationId reserviert sind.
properties.usageDate	string (date-time)	Daten, die dem Auslastungsdatensatz entsprechen. Wenn das Datenkorn monatlich ist, wird es der erste Tag des Monats sein.
properties.usedHours	number (decimal)	Gesamtzahl der von der Reservierung verwendeten Stunden
properties.usedQuantity	number (decimal)	Dies ist die verwendete Menge für die reservierungs-ID.
properties.utilizedPercentage	number (decimal)	Dies ist der verwendete Prozentsatz für die Reservierungs-ID.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

Freigeben über

Reservations Summaries - List By Reservation Order And Reservation

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ReservationSummariesDailyWithReservationId

Beispielanforderung

Beispiel für eine Antwort

ReservationSummariesMonthlyWithReservationId

Beispielanforderung

Beispiel für eine Antwort

Definitionen

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

Zusätzliche Ressourcen