Balances - Get By Billing Account

Referensi

Service:: Consumption

API Version:: 2021-10-01

Mendapatkan saldo untuk cakupan dengan billingAccountId. Saldo tersedia melalui API ini hanya untuk 1 Mei 2014 atau yang lebih baru.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances?api-version=2021-10-01

Parameter URI

Name	In	Required	Type	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-10-01.

Respons

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

Balances

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances?api-version=2021-10-01

import com.azure.core.util.Context;

/** Samples for Balances GetByBillingAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/BalancesByBillingAccount.json
     */
    /**
     * Sample code: Balances.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void balances(com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager.balances().getByBillingAccountWithResponse("123456", Context.NONE);
    }
}

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

package armconsumption_test

import (
	"context"
	"log"

	"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/BalancesByBillingAccount.json
func ExampleBalancesClient_GetByBillingAccount() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewBalancesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetByBillingAccount(ctx,
		"123456",
		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.

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

/**
 * This sample demonstrates how to Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.
 *
 * @summary Gets the balances for a scope by billingAccountId. Balances are 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/BalancesByBillingAccount.json
 */
async function balances() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountId = "123456";
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const result = await client.balances.getByBillingAccount(billingAccountId);
  console.log(result);
}

balances().catch(console.error);

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

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1",
  "name": "balanceId1",
  "type": "Microsoft.Consumption/balances",
  "properties": {
    "currency": "USD  ",
    "beginningBalance": 3396469.19,
    "endingBalance": 2922371.02,
    "newPurchases": 0,
    "adjustments": 0,
    "utilized": 474098.17,
    "serviceOverage": 0,
    "chargesBilledSeparately": 0,
    "totalOverage": 0,
    "totalUsage": 474098.17,
    "azureMarketplaceServiceCharges": 609.82,
    "billingFrequency": "Month",
    "priceHidden": false,
    "newPurchasesDetails": [
      {
        "name": "Promo Purchase",
        "value": 1
      }
    ],
    "adjustmentDetails": [
      {
        "name": "Promo Credit",
        "value": 1.1
      },
      {
        "name": "SIE Credit",
        "value": 1
      }
    ]
  }
}

Definisi

AdjustmentDetails	Daftar Penyesuaian (Kredit promo, kredit SIE, dll.).
Balance	Sumber daya keseimbangan.
BillingFrequency	Frekuensi penagihan.
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 sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".
NewPurchasesDetails	Daftar pembelian baru.

AdjustmentDetails

Daftar Penyesuaian (Kredit promo, kredit SIE, dll.).

Name	Type	Description
name	string	nama penyesuaian baru.
value	number	nilai penyesuaian baru.

Balance

Sumber daya keseimbangan.

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.adjustmentDetails	AdjustmentDetails[]	Daftar Penyesuaian (Kredit promo, kredit SIE, dll.).
properties.adjustments	number	Jumlah penyesuaian total.
properties.azureMarketplaceServiceCharges	number	Total biaya untuk Marketplace Azure.
properties.beginningBalance	number	Saldo awal untuk periode penagihan.
properties.billingFrequency	BillingFrequency	Frekuensi penagihan.
properties.chargesBilledSeparately	number	Biaya ditagih secara terpisah.
properties.currency	string	Mata uang ISO tempat meteran ditagih, misalnya, USD.
properties.endingBalance	number	Saldo akhir untuk periode penagihan (untuk periode terbuka, ini akan diperbarui setiap hari).
properties.newPurchases	number	Total jumlah pembelian baru.
properties.newPurchasesDetails	NewPurchasesDetails[]	Daftar pembelian baru.
properties.priceHidden	boolean	Harga disembunyikan atau tidak.
properties.serviceOverage	number	Kelebihan untuk layanan Azure.
properties.totalOverage	number	serviceOverage + chargesBilledSeparately.
properties.totalUsage	number	Komitmen layanan Azure + total Kelebihan Penggunaan.
properties.utilized	number	Total penggunaan Komitmen.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

BillingFrequency

Frekuensi penagihan.

Name	Type	Description
Month	string
Quarter	string
Year	string

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 sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

Name	Type	Description
error	ErrorDetails	Detail kesalahan.

NewPurchasesDetails

Daftar pembelian baru.

Name	Type	Description
name	string	nama pembelian baru.
value	number	nilai pembelian baru.