Reservations Details - List

Usługa:

Consumption

Wersja interfejsu API:

2024-08-01

Wyświetla szczegóły rezerwacji dla podanego zakresu dat. Uwaga: usługa ARM ma limit rozmiaru ładunku o rozmiarze 12 MB, więc obecnie osoby wywołujące otrzymują 400, gdy rozmiar odpowiedzi przekracza limit usługi ARM. Jeśli rozmiar danych jest zbyt duży, klienci mogą również uzyskać 504, ponieważ limit czasu interfejsu API upłynął limit czasu przygotowywania danych. W takich przypadkach wywołanie interfejsu API powinno być wykonywane z mniejszymi zakresami dat lub wywołanie interfejsu API generowania raportu szczegółów rezerwacji powinno zostać wykonane, ponieważ jest asynchroniczne i nie zostanie przekroczone limity czasu rozmiaru odpowiedzi.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceScope	path	True	string	W pełni kwalifikowany identyfikator zasobu usługi Azure Resource Manager.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Filtruj szczegóły rezerwacji według zakresu dat. Właściwości/Data użycia dla daty rozpoczęcia i daty zakończenia. Filtr obsługuje wartości "le" i "ge". Nie dotyczy podczas wykonywania zapytań przy użyciu profilu rozliczeniowego
endDate	query		string	Data zakończenia. Dotyczy tylko wykonywania zapytań przy użyciu profilu rozliczeniowego
reservationId	query		string	Identyfikator GUID identyfikatora rezerwacji. Ważne tylko wtedy, gdy podano również wartość reservationOrderId. Filtrowanie do określonej rezerwacji
reservationOrderId	query		string	Identyfikator GUID identyfikatora zamówienia rezerwacji. Wymagane, jeśli podano identyfikator rezerwacji. Filtrowanie do określonego zamówienia rezerwacji
startDate	query		string	Data rozpoczęcia. Dotyczy tylko wykonywania zapytań przy użyciu profilu rozliczeniowego

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReservationDetailsListResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

ReservationDetailsByBillingProfileId

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

ReservationDetailsByBillingProfileIdReservationId

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ReservationDetail	zasób szczegółów rezerwacji.
ReservationDetailsListResult	Wynik wyświetlania szczegółów rezerwacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ReservationDetail

Objekt

zasób szczegółów rezerwacji.

Nazwa	Typ	Opis
etag	string	Element etag zasobu.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.instanceFlexibilityGroup	string	Grupa elastyczności wystąpienia.
properties.instanceFlexibilityRatio	string	Współczynnik elastyczności wystąpienia.
properties.instanceId	string	Ten identyfikator jest nazwą zasobu lub w pełni kwalifikowanym identyfikatorem zasobu.
properties.kind	string	Rodzaj rezerwacji.
properties.reservationId	string	Identyfikator rezerwacji jest identyfikatorem rezerwacji w ramach zamówienia rezerwacji. Każda rezerwacja jest grupowaniem w celu zastosowania zakresu korzyści, a także określa liczbę wystąpień, do których można zastosować korzyść rezerwacji.
properties.reservationOrderId	string	Identyfikator zamówienia rezerwacji to identyfikator zakupu rezerwacji. Każdy identyfikator zamówienia rezerwacji reprezentuje jedną transakcję zakupu. Zamówienie rezerwacji zawiera rezerwacje. Zamówienie rezerwacji określa rozmiar maszyny wirtualnej i region rezerwacji.
properties.reservedHours	number (decimal)	Jest to łączna liczba godzin zarezerwowanych dla dnia. Na przykład jeśli rezerwacja dla 1 wystąpienia została wykonana 13:00, będzie to 11 godzin dla tego dnia i 24 godziny od kolejnych dni.
properties.skuName	string	Jest to nazwa jednostki SKU usługi ARM. Może służyć do łączenia z polem serviceType w dodatkowych informacjach w rekordach użycia.
properties.totalReservedQuantity	number (decimal)	Jest to łączna liczba wystąpień zarezerwowanych dla identyfikatora reservationId.
properties.usageDate	string (date-time)	Data wystąpienia zużycia.
properties.usedHours	number (decimal)	Jest to łączna liczba godzin używanych przez wystąpienie.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ReservationDetailsListResult

Objekt

Wynik wyświetlania szczegółów rezerwacji.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	ReservationDetail[]	Lista szczegółów rezerwacji.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która jako ostatnia zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która jako ostatnia zmodyfikowała zasób.