Reservations Details - List

Referens

Service:: Consumption

API Version:: 2023-05-01

Listor reservationsinformationen för angivet datumintervall. Obs! ARM har en storleksgräns för nyttolast på 12 MB, så för närvarande får anropare 400 när svarsstorleken överskrider ARM-gränsen. Om datastorleken är för stor kan kunderna också få 504 när API:et överskrider tidsgränsen för att förbereda data. I sådana fall bör API-anrop göras med mindre datumintervall eller ett anrop till API:et För att generera reservationsinformationsrapport bör göras eftersom det är asynkront och inte överskrider tidsgränsen för svarsstorlek.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceScope	path	True	string	Omfånget som är associerat med reservationsinformationsåtgärder. Detta inkluderar "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för FaktureringKontoomfång (äldre) och "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" för BillingProfile-omfång (modernt).
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2023-03-01.
$filter	query		string	Filtrera reservationsinformation efter datumintervall. Egenskaper/UsageDate för startdatum och slutdatum. Filtret stöder "le" och "ge". Inte tillämpligt vid fråga med faktureringsprofil
endDate	query		string	Slutdatum. Gäller endast vid frågor med faktureringsprofil
reservationId	query		string	RESERVATIONS-ID GUID. Endast giltigt om reservationOrderId också anges. Filtrera efter en specifik reservation
reservationOrderId	query		string	GUID för reservationsbeställnings-ID. Krävs om reservationId anges. Filtrera efter en specifik reservationsbeställning
startDate	query		string	Startdatum. Gäller endast vid frågor med faktureringsprofil

Svar

Name	Typ	Description
200 OK	ReservationDetailsListResult	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Sample Request

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=2023-05-01

Sample Response

Status code:: 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

Sample Request

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=2023-05-01

Sample Response

Status code:: 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

Sample Request

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=2023-05-01

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definitioner

Name	Description
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.
ReservationDetail	resurs för reservationsinformation.
ReservationDetailsListResult	Resultat av att lista reservationsinformation.

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name	Typ	Description
error	ErrorDetails	Information om felet.

ReservationDetail

resurs för reservationsinformation.

Name	Typ	Description
etag	string	Etag för resursen.
id	string	Det fullständiga kvalificerade ARM-ID:t för en händelse.
name	string	Det ID som unikt identifierar en händelse.
properties.instanceFlexibilityGroup	string	Instansflexitetsgruppen.
properties.instanceFlexibilityRatio	string	Förhållandet för instansflexitet.
properties.instanceId	string	Den här identifieraren är namnet på resursen eller det fullständigt kvalificerade resurs-ID:t.
properties.kind	string	Reservationstyp.
properties.reservationId	string	Reservations-ID:t är identifieraren för en reservation i en reservationsbeställning. Varje reservation är gruppering för att tillämpa förmånsomfånget och anger även antalet instanser som reservationsförmånen kan tillämpas på.
properties.reservationOrderId	string	Reservationsbeställnings-ID:t är identifieraren för ett reservationsköp. Varje reservationsbeställnings-ID representerar en enda inköpstransaktion. En reservationsbeställning innehåller reservationer. Reservationsbeställningen anger storleken och regionen för den virtuella datorn för reservationerna.
properties.reservedHours	number	Det här är det totala antalet reserverade timmar för dagen. T.ex. om reservationen för 1 instans gjordes kl. 13.00 är detta 11 timmar för den dagen och 24 timmar från efterföljande dagar.
properties.skuName	string	Det här är ARM SKU-namnet. Den kan användas för att ansluta till fältet serviceType i ytterligare information i användningsposter.
properties.totalReservedQuantity	number	Det här är det totala antalet instanser som är reserverade för reservationId.
properties.usageDate	string	Det datum då förbrukningen inträffade.
properties.usedHours	number	Det här är det totala antalet timmar som används av instansen.
tags	object	Resurstaggar.
type	string	Resurstyp.

ReservationDetailsListResult

Resultat av att lista reservationsinformation.

Name	Typ	Description
nextLink	string	Länken (url) till nästa resultatsida.
value	ReservationDetail[]	Listan med reservationsinformation.

Dela via

Reservations Details - List

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

ReservationDetailsByBillingAccountId

Sample Request

Sample Response

ReservationDetailsByBillingProfileId

Sample Request

Sample Response

ReservationDetailsByBillingProfileIdReservationId

Sample Request

Sample Response

Definitioner

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

Ytterligare resurser