Udostępnij przez

Balances - Get By Billing Account

Usługa:
Consumption
Wersja interfejsu API:
2024-08-01

Pobiera salda dla zakresu według właściwości billingAccountId. Salda są dostępne za pośrednictwem tego interfejsu API tylko dla 1 maja 2014 r. lub nowszego.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
billingAccountId
 path True

string

Identyfikator konta rozliczeniowego
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Balance

Żądanie zakończyło się pomyślnie.
Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Balances

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
  }
}

Definicje

Nazwa Opis
Balance

Zasób salda.
BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem
BillingFrequency

Częstotliwość rozliczeń.
createdByType

Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Balance

Objekt

Zasób salda.

Nazwa Typ Opis
etag

string

Element etag zasobu.
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.adjustmentDetails

BalancePropertiesAdjustmentDetailsItem[]

Lista korekt (środki promocyjne, środki SIE itp.).
properties.adjustments

number (decimal)

Łączna kwota korekty.
properties.azureMarketplaceServiceCharges

number (decimal)

Łączne opłaty za witrynę Azure Marketplace.
properties.beginningBalance

number (decimal)

Początkowe saldo dla okresu rozliczeniowego.
properties.billingFrequency

BillingFrequency

Częstotliwość rozliczeń.
properties.chargesBilledSeparately

number (decimal)

Opłaty rozliczane oddzielnie.
properties.currency

string

Waluta ISO, w której naliczana jest opłata miernika, na przykład USD.
properties.endingBalance

number (decimal)

Saldo końcowe dla okresu rozliczeniowego (w przypadku okresów otwartych zostanie zaktualizowane codziennie).
properties.newPurchases

number (decimal)

Łączna nowa kwota zakupu.
properties.newPurchasesDetails

BalancePropertiesNewPurchasesDetailsItem[]

Lista nowych zakupów.
properties.overageRefund

number (decimal)

Zwroty nadwyżkowe
properties.priceHidden

boolean

Cena jest ukryta lub nie.
properties.serviceOverage

number (decimal)

Nadwyżka usług platformy Azure.
properties.totalOverage

number (decimal)

serviceOverage + chargesBilledSeparately.
properties.totalUsage

number (decimal)

Zobowiązanie usługi platformy Azure i łączna nadwyżka.
properties.utilized

number (decimal)

Łączne użycie zobowiązania.
systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags

object

Tagi zasobów.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

BalancePropertiesAdjustmentDetailsItem

Objekt
Nazwa Typ Opis
name

string

nazwa nowego dostosowania.
value

number (decimal)

wartość nowej korekty.

BalancePropertiesNewPurchasesDetailsItem

Objekt
Nazwa Typ Opis
name

string

nazwa nowego zakupu.
value

number (decimal)

wartość nowego zakupu.

BillingFrequency

Wyliczanie

Częstotliwość rozliczeń.

Wartość Opis
Month
Quarter
Year

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).
createdBy

string

Tożsamość, która utworzyła zasób.
createdByType

createdByType

Typ tożsamości, która utworzyła zasób.
lastModifiedAt

string (date-time)

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy

string

Tożsamość, która jako ostatnia zmodyfikowała zasób.
lastModifiedByType

createdByType

Typ tożsamości, która jako ostatnia zmodyfikowała zasób.