Reservations Details - List

Služba:

Consumption

Verze rozhraní API:

2024-08-01

Zobrazí podrobnosti o rezervacích pro zadaný rozsah kalendářních dat. Poznámka: ARM má limit velikosti datové části 12 MB, takže v současné době volající dostanou 400, když velikost odpovědi překročí limit ARM. Pokud je velikost dat příliš velká, zákazníci můžou získat také 504, protože vypršel časový limit rozhraní API pro přípravu dat. Vtakovýchch datech by se mělo volat rozhraní API

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceScope	path	True	string	Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Vyfiltrujte podrobnosti rezervace podle rozsahu kalendářních dat. Vlastnosti /UsageDate pro počáteční a koncové datum. Filtr podporuje "le" a "ge". Nejde použít při dotazování s fakturačním profilem
endDate	query		string	Koncové datum. Platí pouze při dotazování s fakturačním profilem.
reservationId	query		string	IDENTIFIKÁTOR GUID ID rezervace. Platné pouze v případě, že je k dispozici idobjednávky reservationOrderId. Filtrování podle konkrétní rezervace
reservationOrderId	query		string	IDENTIFIKÁTOR GUID objednávky rezervace. Vyžaduje se, pokud je k dispozici ID rezervace. Filtrování podle konkrétní objednávky rezervace
startDate	query		string	Počáteční datum. Platí pouze při dotazování s fakturačním profilem.

Odpovědi

Name	Typ	Description
200 OK	ReservationDetailsListResult	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ReservationDetail	zdroj podrobností rezervace.
ReservationDetailsListResult	Výsledek výpisu podrobností o rezervaci
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ReservationDetail

Objekt

zdroj podrobností rezervace.

Name	Typ	Description
etag	string	Etag prostředku.
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.instanceFlexibilityGroup	string	Skupina flexibility instance.
properties.instanceFlexibilityRatio	string	Poměr flexibility instance.
properties.instanceId	string	Tento identifikátor je název prostředku nebo plně kvalifikované ID prostředku.
properties.kind	string	Druh rezervace.
properties.reservationId	string	ID rezervace je identifikátor rezervace v rámci objednávky rezervace. Každá rezervace je seskupení pro uplatnění rozsahu výhod a také určuje počet instancí, na které se dá výhoda rezervace použít.
properties.reservationOrderId	string	ID objednávky rezervace je identifikátor nákupu rezervace. Každé ID objednávky rezervace představuje jednu nákupní transakci. Objednávka rezervace obsahuje rezervace. Objednávka rezervace určuje velikost a oblast virtuálního počítače pro rezervace.
properties.reservedHours	number (decimal)	Toto je celková doba vyhrazená pro den. Například pokud byla rezervace 1 instance provedena 1:00, bude to 11 hodin pro tento den a 24 hodin od následujících dnů.
properties.skuName	string	Toto je název skladové položky ARM. Dá se použít ke spojení s polem serviceType v dalších informacích v záznamech o využití.
properties.totalReservedQuantity	number (decimal)	Toto je celkový počet instancí, které jsou rezervované pro reservationId.
properties.usageDate	string (date-time)	Datum, kdy došlo ke spotřebě.
properties.usedHours	number (decimal)	Toto je celkový počet hodin, které instance používá.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

ReservationDetailsListResult

Objekt

Výsledek výpisu podrobností o rezervaci

Name	Typ	Description
nextLink	string	Odkaz (url) na další stránku výsledků.
value	ReservationDetail[]	Seznam podrobností o rezervaci.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.