Balances - Get By Billing Account

Szolgáltatás:

Consumption

API-verzió:

2024-08-01

Lekéri egy hatókör egyenlegeit a billingAccountId alapján. Az egyenlegek csak 2014. május 1-jei vagy újabb api-val érhetők el.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountId	path	True	string	BillingAccount azonosítója
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	Balance	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Balances

Mintakérelem

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.consumption import ConsumptionManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-consumption
# USAGE
    python balances_by_billing_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ConsumptionManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.balances.get_by_billing_account(
        billing_account_id="123456",
    )
    print(response)


# x-ms-original-file: 2024-08-01/BalancesByBillingAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

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/v2"
)

// Generated from example definition: 2024-08-01/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()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBalancesClient().GetByBillingAccount(ctx, "123456", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armconsumption.BalancesClientGetByBillingAccountResponse{
	// 	Balance: armconsumption.Balance{
	// 		Name: to.Ptr("balanceId1"),
	// 		Type: to.Ptr("Microsoft.Consumption/balances"),
	// 		ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1"),
	// 		Properties: &armconsumption.BalanceProperties{
	// 			AdjustmentDetails: []*armconsumption.BalancePropertiesAdjustmentDetailsItem{
	// 				{
	// 					Name: to.Ptr("Promo Credit"),
	// 					Value: to.Ptr[float64](1.1),
	// 				},
	// 				{
	// 					Name: to.Ptr("SIE Credit"),
	// 					Value: to.Ptr[float64](1),
	// 				},
	// 			},
	// 			Adjustments: to.Ptr[float64](0),
	// 			AzureMarketplaceServiceCharges: to.Ptr[float64](609.82),
	// 			BeginningBalance: to.Ptr[float64](3396469.19),
	// 			BillingFrequency: to.Ptr(armconsumption.BillingFrequencyMonth),
	// 			ChargesBilledSeparately: to.Ptr[float64](0),
	// 			Currency: to.Ptr("USD  "),
	// 			EndingBalance: to.Ptr[float64](2922371.02),
	// 			NewPurchases: to.Ptr[float64](0),
	// 			NewPurchasesDetails: []*armconsumption.BalancePropertiesNewPurchasesDetailsItem{
	// 				{
	// 					Name: to.Ptr("Promo Purchase"),
	// 					Value: to.Ptr[float64](1),
	// 				},
	// 			},
	// 			OverageRefund: to.Ptr[float64](2012.61),
	// 			PriceHidden: to.Ptr(false),
	// 			ServiceOverage: to.Ptr[float64](0),
	// 			TotalOverage: to.Ptr[float64](0),
	// 			TotalUsage: to.Ptr[float64](474098.17),
	// 			Utilized: to.Ptr[float64](474098.17),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
Balance	Egyenlegerőforrás.
BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem
BillingFrequency	A számlázási gyakoriság.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Balance

Tárgy

Egyenlegerőforrás.

Name	Típus	Description
etag	string	Az erőforrás etagje.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.adjustmentDetails	BalancePropertiesAdjustmentDetailsItem[]	Kiigazítások listája (promóciós kredit, SIE-kredit stb.).
properties.adjustments	number (decimal)	Teljes kiigazítási összeg.
properties.azureMarketplaceServiceCharges	number (decimal)	Az Azure Marketplace teljes díjai.
properties.beginningBalance	number (decimal)	A számlázási időszak kezdő egyenlege.
properties.billingFrequency	BillingFrequency	A számlázási gyakoriság.
properties.chargesBilledSeparately	number (decimal)	Külön számlázott díjak.
properties.currency	string	Az ISO pénznem, amelyben a fogyasztásmérőt felszámítják, például USD.
properties.endingBalance	number (decimal)	A számlázási időszak záró egyenlege (nyitott időszakok esetén ez naponta frissül).
properties.newPurchases	number (decimal)	Új vásárlás teljes összege.
properties.newPurchasesDetails	BalancePropertiesNewPurchasesDetailsItem[]	Az új vásárlások listája.
properties.overageRefund	number (decimal)	Túlhasználati visszatérítések
properties.priceHidden	boolean	Az ár rejtett vagy nem.
properties.serviceOverage	number (decimal)	Azure-szolgáltatások túlhasználata.
properties.totalOverage	number (decimal)	szolgáltatásOverage + chargesBilledSeparate lehetőségre.
properties.totalUsage	number (decimal)	Azure-szolgáltatási kötelezettségvállalás + teljes túlhasználat.
properties.utilized	number (decimal)	Teljes kötelezettségvállalási használat.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

BalancePropertiesAdjustmentDetailsItem

Tárgy

Name	Típus	Description
name	string	az új kiigazítás neve.
value	number (decimal)	az új kiigazítás értéke.

BalancePropertiesNewPurchasesDetailsItem

Tárgy

Name	Típus	Description
name	string	az új vásárlás neve.
value	number (decimal)	az új vásárlás értéke.

BillingFrequency

Felsorolás

A számlázási gyakoriság.

Érték	Description
Month
Quarter
Year

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.