Balances - Get By Billing Account

Referenz

Dienst:: Consumption

API-Version:: 2024-08-01

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
billingAccountId	path	True	string	BillingAccount-ID
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2023-03-01.

Antworten

Name	Typ	Beschreibung
200 OK	Balance	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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,
    "overageRefund": 2012.61,
    "newPurchasesDetails": [
      {
        "name": "Promo Purchase",
        "value": 1
      }
    ],
    "adjustmentDetails": [
      {
        "name": "Promo Credit",
        "value": 1.1
      },
      {
        "name": "SIE Credit",
        "value": 1
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AdjustmentDetails	Liste der Anpassungen (Promo-Gutschrift, SIE-Gutschrift usw.).
Balance	Eine Saldoressource.
BillingFrequency	Die Abrechnungshäufigkeit.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit. 504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.
NewPurchasesDetails	Liste der neuen Einkäufe.

AdjustmentDetails

Objekt

Liste der Anpassungen (Promo-Gutschrift, SIE-Gutschrift usw.).

Name	Typ	Beschreibung
name	string	der Name der neuen Anpassung.
value	number (decimal)	der Wert der neuen Anpassung.

Balance

Objekt

Eine Saldoressource.

Name	Typ	Beschreibung
etag	string	Das Etag für die Ressource.
id	string	Die vollständige qualifizierte ARM-ID eines Ereignisses.
name	string	Die ID, die ein Ereignis eindeutig identifiziert.
properties.adjustmentDetails	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	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	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)	serviceOverage + chargesBilledSeparately.
properties.totalUsage	number (decimal)	Azure-Dienstverpflichtung + Gesamtüberlastung.
properties.utilized	number (decimal)	Gesamtnutzung der Verpflichtung.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

BillingFrequency

Enumeration

Die Abrechnungshäufigkeit.

Wert	Beschreibung
Month
Quarter
Year

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

NewPurchasesDetails

Objekt

Liste der neuen Einkäufe.

Name	Typ	Beschreibung
name	string	der Name des neuen Kaufs.
value	number (decimal)	der Wert des neuen Kaufs.

Freigeben über

Balances - Get By Billing Account

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Balances

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdjustmentDetails

Balance

BillingFrequency

ErrorDetails

ErrorResponse

NewPurchasesDetails

Zusätzliche Ressourcen