Aracılığıyla paylaş


Reservations Summaries - List

Tanımlanan kapsam için günlük veya aylık dilim için rezervasyon özetlerini listeler. Not: ARM'nin yük boyutu sınırı 12 MB olduğundan yanıt boyutu ARM sınırını aştığında şu anda arayanlar 400 alır. Böyle durumlarda API çağrısı daha küçük tarih aralıklarıyla yapılmalıdır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceScope
path True

string

Kaynağın tam Azure Resource manager tanımlayıcısı.

api-version
query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

grain
query True

Datagrain

Günlük veya aylık olabilir

$filter
query

string

Yalnızca günlük tahıl için gereklidir. Başlangıç tarihi ve bitiş tarihi için özellikler/KullanımTarihi. Filtre 'le' ve 'ge'yi destekler. Faturalama profiliyle sorgularken geçerli değildir

endDate
query

string

Bitiş tarihi. Yalnızca faturalama profiliyle sorgulama yaparken geçerlidir

reservationId
query

string

Rezervasyon Kimliği GUID'si. Yalnızca reservationOrderId de sağlandığında geçerlidir. Belirli bir rezervasyona göre filtreleme

reservationOrderId
query

string

Rezervasyon Sipariş Kimliği GUID'si. reservationId sağlanmışsa gereklidir. Belirli bir rezervasyon siparişine göre filtreleme

startDate
query

string

Başlangıç tarihi. Yalnızca faturalama profiliyle sorgulama yaparken geçerlidir

Yanıtlar

Name Tür Description
200 OK

ReservationSummariesListResult

İstek başarılı oldu.

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

ReservationSummariesDailyWithBillingAccountId
ReservationSummariesDailyWithBillingProfileId
ReservationSummariesMonthlyWithBillingAccountId
ReservationSummariesMonthlyWithBillingProfileId
ReservationSummariesMonthlyWithBillingProfileIdReservationId

ReservationSummariesDailyWithBillingAccountId

Örnek isteği

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

Örnek yanıt

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesDailyWithBillingProfileId

Örnek isteği

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=daily&startDate=2017-10-01&endDate=2017-11-20

Örnek yanıt

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingAccountId

Örnek isteği

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly

Örnek yanıt

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileId

Örnek isteği

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly

Örnek yanıt

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Örnek isteği

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

Örnek yanıt

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

Tanımlar

Name Description
createdByType

Kaynağı oluşturan kimliğin türü.

Datagrain
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

ReservationSummariesListResult

Rezervasyon özetlerinin listelenmesi sonucu.

ReservationSummary

rezervasyon özeti kaynağı.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Kaynağı oluşturan kimliğin türü.

Değer Description
User
Application
ManagedIdentity
Key

Datagrain

Değer Description
daily

Günlük veri dilimi

monthly

Aylık veri dilimi

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

ReservationSummariesListResult

Rezervasyon özetlerinin listelenmesi sonucu.

Name Tür Description
nextLink

string

Sonuçların sonraki sayfasına bağlantı (URL).

value

ReservationSummary[]

Rezervasyon özetlerinin listesi.

ReservationSummary

rezervasyon özeti kaynağı.

Name Tür Description
etag

string

Kaynağın etag'i.

id

string

Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Kaynağın adı

properties.avgUtilizationPercentage

number (decimal)

Bu, tüm zaman aralığı için ortalama kullanımdır. (tahıla bağlı olarak gün veya ay)

properties.kind

string

Rezervasyon türü.

properties.maxUtilizationPercentage

number (decimal)

Bu, kullanım süresi (gün veya ay) içindeki en yüksek saatlik kullanımdır. Örneğin, kullanım kaydı 10.10.12.2017'ye karşılık geliyorsa ve 4. ve 5. saatte kullanım 100%ise, bu alan o gün için 100% döndürür.

properties.minUtilizationPercentage

number (decimal)

Bu, kullanım süresindeki (gün veya ay) en düşük saatlik kullanımdır. Örneğin, kullanım kaydı 10.12.2017'ye karşılık geliyorsa ve 4. ve 5. saatte kullanım 10%ise, bu alan o gün için 10% döndürür

properties.purchasedQuantity

number (decimal)

Bu, reservationId için satın alınan miktardır.

properties.remainingQuantity

number (decimal)

Bu, reservationId değerinin kalan miktarıdır.

properties.reservationId

string

Rezervasyon kimliği, rezervasyon siparişi içindeki rezervasyonun tanımlayıcısıdır. Her rezervasyon, avantaj kapsamını uygulamaya yönelik gruplandırmadır ve rezervasyon avantajının uygulanabileceği örnek sayısını da belirtir.

properties.reservationOrderId

string

Rezervasyon siparişi kimliği, rezervasyon satın alma işleminin tanımlayıcısıdır. Her rezervasyon siparişi kimliği tek bir satın alma işlemini temsil eder. Rezervasyon siparişi rezervasyonları içerir. Rezervasyon sırası, rezervasyonlar için VM boyutunu ve bölgesini belirtir.

properties.reservedHours

number (decimal)

Bu, ayrılmış toplam saattir. Örneğin, 1 örnek için rezervasyon 13:00'te yapılmışsa, bu, o gün için 11 saat ve sonraki günlerden itibaren 24 saat olacaktır

properties.skuName

string

Bu ARM Sku adıdır. Kullanım kayıtlarındaki ek bilgilerde serviceType alanına katılmak için kullanılabilir.

properties.totalReservedQuantity

number (decimal)

Bu, reservationId için ayrılmış örneklerin toplam sayısıdır.

properties.usageDate

string (date-time)

Kullanım kaydına karşılık gelen veriler. Veri dilimi aylıksa, ayın ilk günü olur.

properties.usedHours

number (decimal)

Rezervasyon tarafından kullanılan toplam saat sayısı

properties.usedQuantity

number (decimal)

Bu, reservationId için kullanılan miktardır.

properties.utilizedPercentage

number (decimal)

Bu, rezervasyon kimliği için kullanılan yüzdedir.

systemData

systemData

createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.

tags

object

Kaynak etiketleri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string (date-time)

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string (date-time)

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimlik türü.