Price Sheet - Get By Billing Period

Service:

Consumption

API Version:

2021-10-01

Dapatkan lembar harga untuk cakupan berdasarkan subscriptionId dan periode penagihan. Lembar harga tersedia melalui API ini hanya untuk 1 Mei 2014 atau yang lebih baru.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?api-version=2021-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}&api-version=2021-10-01

Parameter URI

Name	In	Required	Type	Description
billingPeriodName	path	True	string	Nama Periode Penagihan.
subscriptionId	path	True	string	ID Langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-10-01.
$expand	query		string	Dapat digunakan untuk memperluas properti/meterDetails dalam lembar harga. Secara default, bidang ini tidak disertakan saat mengembalikan lembar harga.
$skiptoken	query		string	Skiptoken hanya digunakan jika operasi sebelumnya mengembalikan hasil parsial. Jika respons sebelumnya berisi elemen nextLink, nilai elemen nextLink akan menyertakan parameter skiptoken yang menentukan titik awal yang akan digunakan untuk panggilan berikutnya.
$top	query		integer int32	Dapat digunakan untuk membatasi jumlah hasil ke hasil N teratas.

Respons

Name	Type	Description
200 OK	PriceSheetResult	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

PriceSheetExpand

PriceSheetForBillingPeriod

PriceSheetExpand

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?$expand=meterDetails&api-version=2021-10-01

Java

import com.azure.core.util.Context;

/** Samples for PriceSheet GetByBillingPeriod. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/PriceSheetExpand.json
     */
    /**
     * Sample code: PriceSheetExpand.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void priceSheetExpand(com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager.priceSheets().getByBillingPeriodWithResponse("201801", "meterDetails", null, null, 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/PriceSheetExpand.json
func ExamplePriceSheetClient_GetByBillingPeriod() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewPriceSheetClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetByBillingPeriod(ctx,
		"201801",
		&armconsumption.PriceSheetClientGetByBillingPeriodOptions{Expand: to.Ptr("meterDetails"),
			Skiptoken: nil,
			Top:       nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
 *
 * @summary Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/PriceSheetExpand.json
 */
async function priceSheetExpand() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const expand = "meterDetails";
  const billingPeriodName = "201801";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const result = await client.priceSheet.getByBillingPeriod(billingPeriodName, options);
  console.log(result);
}

priceSheetExpand().catch(console.error);

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1",
        "meterDetails": {
          "meterName": "Data Transfer Out (GB)",
          "meterCategory": "Networking",
          "unit": "GB",
          "meterLocation": "Zone 2",
          "totalIncludedQuantity": 0,
          "pretaxStandardRate": 0.138
        }
      }
    ]
  }
}

PriceSheetForBillingPeriod

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?api-version=2021-10-01

Java

import com.azure.core.util.Context;

/** Samples for PriceSheet GetByBillingPeriod. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/PriceSheetForBillingPeriod.json
     */
    /**
     * Sample code: PriceSheetForBillingPeriod.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void priceSheetForBillingPeriod(com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager.priceSheets().getByBillingPeriodWithResponse("201801", null, null, 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 Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
 *
 * @summary Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/PriceSheetForBillingPeriod.json
 */
async function priceSheetForBillingPeriod() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingPeriodName = "201801";
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const result = await client.priceSheet.getByBillingPeriod(billingPeriodName);
  console.log(result);
}

priceSheetForBillingPeriod().catch(console.error);

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1"
      }
    ]
  }
}

Definisi

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".
MeterDetails	Properti detail meteran.
PriceSheetProperties	Properti lembar harga.
PriceSheetResult	Sumber daya lembar harga.

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.

MeterDetails

Properti detail meteran.

Name	Type	Description
meterCategory	string	Kategori meteran, misalnya, 'Layanan cloud', 'Jaringan', dll..
meterLocation	string	Lokasi tempat layanan Azure tersedia.
meterName	string	Nama meteran, dalam kategori meteran yang diberikan
meterSubCategory	string	Subkataan meteran, misalnya, 'Layanan cloud A6', 'ExpressRoute (IXP)', dll..
pretaxStandardRate	number	Harga daftar pretaks.
serviceName	string	Nama layanan.
serviceTier	string	Tingkat layanan.
totalIncludedQuantity	number	Total kuantitas yang disertakan yang terkait dengan penawaran.
unit	string	Unit tempat konsumsi meteran dibebankan, misalnya, 'Jam', 'GB', dll.

PriceSheetProperties

Properti lembar harga.

Name	Type	Description
billingPeriodId	string	Id sumber daya periode penagihan tempat penggunaan berada.
currencyCode	string	Kode mata uang
includedQuantity	number	Kualitas yang disertakan untuk penawaran
meterDetails	MeterDetails	Detail tentang meteran. Secara default ini tidak diisi, kecuali ditentukan dalam $expand.
meterId	string	Id meter (GUID)
offerId	string	Id Penawaran
partNumber	string	Nomor Bagian
unitOfMeasure	string	Satuan ukuran
unitPrice	number	Harga Satuan

PriceSheetResult

Sumber daya lembar harga.

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.download	MeterDetails	Detail unduhan pricesheet.
properties.nextLink	string	Tautan (url) ke halaman hasil berikutnya.
properties.pricesheets	PriceSheetProperties[]	Lembar harga
tags	object	Tag sumber daya.
type	string	Jenis sumber daya