Share via


Balances - Get For Billing Period By Billing Account

Hiermee haalt u de saldi voor een bereik op per factureringsperiode en billingAccountId. Saldi zijn alleen beschikbaar via deze API voor 1 mei 2014 of hoger.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances?api-version=2023-05-01

URI-parameters

Name In Vereist Type Description
billingAccountId
path True

string

Factureringsaccount-id

billingPeriodName
path True

string

Naam van factureringsperiode.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2023-03-01.

Antwoorden

Name Type Description
200 OK

Balance

OK. De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

Balances

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/billingPeriods/201702/providers/Microsoft.Consumption/balances?api-version=2023-05-01

Sample Response

{
  "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
      }
    ]
  }
}

Definities

Name Description
AdjustmentDetails

Lijst met aanpassingen (promotietegoed, SIE-tegoed, enzovoort).

Balance

Een balansresource.

BillingFrequency

De factureringsfrequentie.

ErrorDetails

De details van de fout.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Enkele foutberichten:

  • 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'.

  • 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.

NewPurchasesDetails

Lijst met nieuwe aankopen.

AdjustmentDetails

Lijst met aanpassingen (promotietegoed, SIE-tegoed, enzovoort).

Name Type Description
name

string

de naam van de nieuwe aanpassing.

value

number

de waarde van de nieuwe aanpassing.

Balance

Een balansresource.

Name Type Description
etag

string

De etag voor de resource.

id

string

De volledig gekwalificeerde ARM-id van een gebeurtenis.

name

string

De id die een gebeurtenis uniek identificeert.

properties.adjustmentDetails

AdjustmentDetails[]

Lijst met aanpassingen (promotietegoed, SIE-tegoed, enzovoort).

properties.adjustments

number

Totaal aanpassingsbedrag.

properties.azureMarketplaceServiceCharges

number

Totale kosten voor Azure Marketplace.

properties.beginningBalance

number

Het beginsaldo voor de factureringsperiode.

properties.billingFrequency

BillingFrequency

De factureringsfrequentie.

properties.chargesBilledSeparately

number

Kosten afzonderlijk gefactureerd.

properties.currency

string

De ISO-valuta waarin de meter in rekening wordt gebracht, bijvoorbeeld USD.

properties.endingBalance

number

Het eindsaldo voor de factureringsperiode (voor openstaande perioden wordt dit dagelijks bijgewerkt).

properties.newPurchases

number

Totaal nieuw aankoopbedrag.

properties.newPurchasesDetails

NewPurchasesDetails[]

Lijst met nieuwe aankopen.

properties.overageRefund

number

Restitutie van overschrijding

properties.priceHidden

boolean

Prijs is verborgen of niet.

properties.serviceOverage

number

Overschrijding voor Azure-services.

properties.totalOverage

number

serviceOverage + chargesBilledSeparately.

properties.totalUsage

number

Azure-serviceverplichting + totale overschrijding.

properties.utilized

number

Gebruik van totale toezegging.

tags

object

Resourcetags.

type

string

Resourcetype.

BillingFrequency

De factureringsfrequentie.

Name Type Description
Month

string

Quarter

string

Year

string

ErrorDetails

De details van de fout.

Name Type Description
code

string

Foutcode.

message

string

Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Enkele foutberichten:

  • 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'.

  • 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.

Name Type Description
error

ErrorDetails

De details van de fout.

NewPurchasesDetails

Lijst met nieuwe aankopen.

Name Type Description
name

string

de naam van de nieuwe aankoop.

value

number

de waarde van de nieuwe aankoop.