Balances - Get By Billing Account
Ruft die Saldos für einen Bereich durch billingAccountId ab. Saldos sind nur für den 1. Mai 2014 oder höher über diese API verfügbar.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances?api-version=2024-08-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
billing
|
path | True |
string |
BillingAccount-ID |
|
api-version
|
query | True |
string minLength: 1 |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Balances
Beispielanforderung
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances?api-version=2024-08-01
Beispiel für eine Antwort
{
"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
}
}
Definitionen
| Name | Beschreibung |
|---|---|
| Balance |
Eine Saldoressource. |
|
Balance |
|
|
Balance |
|
|
Billing |
Die Abrechnungshäufigkeit. |
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
Balance
Eine Saldoressource.
| Name | Typ | Beschreibung |
|---|---|---|
| etag |
string |
Das Etag für die Ressource. |
| id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Der Name der Ressource |
| properties.adjustmentDetails |
Liste der Anpassungen (Promo-Gutschrift, SIE-Gutschrift usw.). |
|
| properties.adjustments |
number (decimal) |
Gesamtanpassungsbetrag. |
| properties.azureMarketplaceServiceCharges |
number (decimal) |
Gesamtgebühren für Azure Marketplace. |
| properties.beginningBalance |
number (decimal) |
Der Anfangssaldo für den Abrechnungszeitraum. |
| properties.billingFrequency |
Die Abrechnungshäufigkeit. |
|
| properties.chargesBilledSeparately |
number (decimal) |
Gebühren separat abgerechnet. |
| properties.currency |
string |
Die ISO-Währung, in der der Zähler berechnet wird, z. B. USD. |
| properties.endingBalance |
number (decimal) |
Der Endsaldo für den Abrechnungszeitraum (für offene Zeiträume wird dies täglich aktualisiert). |
| properties.newPurchases |
number (decimal) |
Gesamtsumme des neuen Einkaufsbetrags. |
| properties.newPurchasesDetails |
Liste der neuen Einkäufe. |
|
| properties.overageRefund |
number (decimal) |
Überlastung von Rückerstattungen |
| properties.priceHidden |
boolean |
Der Preis ist ausgeblendet oder nicht. |
| properties.serviceOverage |
number (decimal) |
Überlastung für Azure-Dienste. |
| properties.totalOverage |
number (decimal) |
ServiceÜberschreitung + GebührenSeparat abgerechnet. |
| properties.totalUsage |
number (decimal) |
Azure-Dienstverpflichtung + Gesamtüberlastung. |
| properties.utilized |
number (decimal) |
Gesamtnutzung der Verpflichtung. |
| systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
|
| tags |
object |
Ressourcentags. |
| type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
BalancePropertiesAdjustmentDetailsItem
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
der Name der neuen Anpassung. |
| value |
number (decimal) |
der Wert der neuen Anpassung. |
BalancePropertiesNewPurchasesDetailsItem
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
der Name des neuen Kaufs. |
| value |
number (decimal) |
der Wert des neuen Kaufs. |
BillingFrequency
Die Abrechnungshäufigkeit.
| Wert | Beschreibung |
|---|---|
| Month | |
| Quarter | |
| Year |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
| Name | Typ | Beschreibung |
|---|---|---|
| createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
| createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
| createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
| lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
| lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
| lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |