Reservations Summaries - List By Reservation Order And Reservation

Service:

Consumption

API Version:

2021-10-01

Mencantumkan ringkasan reservasi untuk butir harian atau bulanan.

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

With optional parameters:

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

Parameter URI

Name	In	Required	Type	Description
reservationId	path	True	string	Id reservasi
reservationOrderId	path	True	string	Id Pesanan reservasi
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-10-01.
grain	query	True	datagrain	Bisa harian atau bulanan
$filter	query		string	Diperlukan hanya untuk biji-bijian harian. Properti/UsageDate untuk tanggal mulai dan tanggal selesai. Filter mendukung 'le' dan 'ge'

Respons

Name	Type	Description
200 OK	ReservationSummariesListResult	OK. Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Sample Request

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=2021-10-01

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.consumption.models.Datagrain;

/** Samples for ReservationsSummaries ListByReservationOrderAndReservation. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationSummariesDailyWithReservationId.json
     */
    /**
     * Sample code: ReservationSummariesDailyWithReservationId.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void reservationSummariesDailyWithReservationId(
        com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager
            .reservationsSummaries()
            .listByReservationOrderAndReservation(
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                Datagrain.DAILY,
                "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20",
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationSummariesDailyWithReservationId.json
func ExampleReservationsSummariesClient_NewListByReservationOrderAndReservationPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewReservationsSummariesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByReservationOrderAndReservationPager("00000000-0000-0000-0000-000000000000",
		"00000000-0000-0000-0000-000000000000",
		armconsumption.DatagrainDailyGrain,
		&armconsumption.ReservationsSummariesClientListByReservationOrderAndReservationOptions{Filter: to.Ptr("properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20")})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { ConsumptionManagementClient } = require("@azure/arm-consumption");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the reservations summaries for daily or monthly grain.
 *
 * @summary Lists the reservations summaries for daily or monthly grain.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationSummariesDailyWithReservationId.json
 */
async function reservationSummariesDailyWithReservationId() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const reservationOrderId = "00000000-0000-0000-0000-000000000000";
  const reservationId = "00000000-0000-0000-0000-000000000000";
  const grain = "daily";
  const filter = "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20";
  const options = {
    filter,
  };
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reservationsSummaries.listByReservationOrderAndReservation(
    reservationOrderId,
    reservationId,
    grain,
    options
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

reservationSummariesDailyWithReservationId().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

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

Sample Request

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=2021-10-01

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.consumption.models.Datagrain;

/** Samples for ReservationsSummaries ListByReservationOrderAndReservation. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationSummariesMonthlyWithReservationId.json
     */
    /**
     * Sample code: ReservationSummariesMonthlyWithReservationId.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void reservationSummariesMonthlyWithReservationId(
        com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager
            .reservationsSummaries()
            .listByReservationOrderAndReservation(
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                Datagrain.MONTHLY,
                null,
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { ConsumptionManagementClient } = require("@azure/arm-consumption");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the reservations summaries for daily or monthly grain.
 *
 * @summary Lists the reservations summaries for daily or monthly grain.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationSummariesMonthlyWithReservationId.json
 */
async function reservationSummariesMonthlyWithReservationId() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const reservationOrderId = "00000000-0000-0000-0000-000000000000";
  const reservationId = "00000000-0000-0000-0000-000000000000";
  const grain = "monthly";
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reservationsSummaries.listByReservationOrderAndReservation(
    reservationOrderId,
    reservationId,
    grain
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

reservationSummariesMonthlyWithReservationId().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

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

Definisi

datagrain	Bisa harian atau bulanan
ErrorDetails	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan. Beberapa respons Kesalahan: 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Layanan untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".
ReservationSummariesListResult	Hasil daftar ringkasan reservasi.
ReservationSummary	sumber daya ringkasan reservasi.

datagrain

Bisa harian atau bulanan

Name	Type	Description
daily	string	Butir data harian
monthly	string	Butir data bulanan

ErrorDetails

Detail kesalahan.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Beberapa respons Kesalahan:

• 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after".

• 503 ServiceUnavailable - Layanan untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

Name	Type	Description
error	ErrorDetails	Detail kesalahan.

ReservationSummariesListResult

Hasil daftar ringkasan reservasi.

Name	Type	Description
nextLink	string	Tautan (url) ke halaman hasil berikutnya.
value	ReservationSummary[]	Daftar ringkasan reservasi.

ReservationSummary

sumber daya ringkasan reservasi.

Name	Type	Description
etag	string	Etag untuk sumber daya.
id	string	ID ARM lengkap yang memenuhi syarat dari suatu peristiwa.
name	string	ID yang secara unik mengidentifikasi peristiwa.
properties.avgUtilizationPercentage	number	Ini adalah pemanfaatan rata-rata untuk seluruh rentang waktu. (hari atau bulan tergantung pada biji-bijian)
properties.kind	string	Jenis reservasi.
properties.maxUtilizationPercentage	number	Ini adalah pemanfaatan per jam maksimum dalam waktu penggunaan (hari atau bulan). Misalnya, jika catatan penggunaan sesuai dengan 10/12/2017 dan pada itu untuk jam 4 dan 5, pemanfaatannya adalah 100%, bidang ini akan mengembalikan 100% untuk hari itu.
properties.minUtilizationPercentage	number	Ini adalah pemanfaatan per jam minimum dalam waktu penggunaan (hari atau bulan). Misalnya jika catatan penggunaan sesuai dengan 10/12/2017 dan pada saat itu untuk jam 4 dan 5, pemanfaatan adalah 10%, bidang ini akan mengembalikan 10% untuk hari itu
properties.purchasedQuantity	number	Ini adalah jumlah yang dibeli untuk reservationId.
properties.remainingQuantity	number	Ini adalah jumlah yang tersisa untuk reservationId.
properties.reservationId	string	ID reservasi adalah pengidentifikasi reservasi dalam pesanan reservasi. Setiap reservasi adalah pengelompokan untuk menerapkan cakupan manfaat dan juga menentukan jumlah instans tempat manfaat reservasi dapat diterapkan.
properties.reservationOrderId	string	ID pesanan reservasi adalah pengidentifikasi untuk pembelian reservasi. Setiap ID pesanan reservasi mewakili satu transaksi pembelian. Pesanan reservasi berisi reservasi. Pesanan reservasi menentukan ukuran dan wilayah VM untuk reservasi.
properties.reservedHours	number	Ini adalah total jam yang dipesan. Misalnya, jika reservasi untuk 1 instans dilakukan pada pukul 13.00, ini akan menjadi 11 jam untuk hari itu dan 24 jam dari hari berikutnya
properties.skuName	string	Ini adalah nama ARM Sku. Ini dapat digunakan untuk bergabung dengan bidang serviceType dalam info tambahan dalam rekaman penggunaan.
properties.totalReservedQuantity	number	Ini adalah jumlah total instans yang dicadangkan untuk reservationId.
properties.usageDate	string	Data yang sesuai dengan catatan pemanfaatan. Jika butir data adalah bulanan, itu akan menjadi hari pertama dalam sebulan.
properties.usedHours	number	Total jam yang digunakan berdasarkan reservasi
properties.usedQuantity	number	Ini adalah jumlah yang digunakan untuk reservationId.
properties.utilizedPercentage	number	Ini adalah persentase yang digunakan untuk Id reservasi.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya