Поделиться через

Balances - Get By Billing Account

  • Ссылка
Служба:
Consumption
Версия API:
2024-08-01

Возвращает балансы для области по выставлению счетовAccountId. Балансы доступны только через этот API 1 мая 2014 г. или более поздней версии.

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

Параметры URI

Имя В Обязательно Тип Описание
billingAccountId
 path True

string

Идентификатор BillingAccount
api-version
 query True

string

Версия API для использования с клиентским запросом. Текущая версия — 2023-03-01.

Ответы

Имя Тип Описание
200 OK

Balance

ХОРОШО. Запрос выполнен успешно.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Balances

Образец запроса

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

Пример ответа

Код состояния:
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
      }
    ]
  }
}

Определения

Имя Описание
AdjustmentDetails

Список корректировк (промо-кредит, кредит SIE и т. д.).
Balance

Ресурс балансировки.
BillingFrequency

Частота выставления счетов.
ErrorDetails

Сведения об ошибке.
ErrorResponse

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.

  • Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.
NewPurchasesDetails

Список новых покупок.

AdjustmentDetails

Object

Список корректировк (промо-кредит, кредит SIE и т. д.).

Имя Тип Описание
name

string

имя новой корректировки.
value

number (decimal)

значение новой корректировки.

Balance

Object

Ресурс балансировки.

Имя Тип Описание
etag

string

Etag для ресурса.
id

string

Полный идентификатор ARM события.
name

string

Идентификатор, который однозначно идентифицирует событие.
properties.adjustmentDetails

AdjustmentDetails[]

Список корректировк (промо-кредит, кредит SIE и т. д.).
properties.adjustments

number (decimal)

Общая сумма корректировки.
properties.azureMarketplaceServiceCharges

number (decimal)

Общая плата за Azure Marketplace.
properties.beginningBalance

number (decimal)

Начальный баланс для периода выставления счетов.
properties.billingFrequency

BillingFrequency

Частота выставления счетов.
properties.chargesBilledSeparately

number (decimal)

Плата взимается отдельно.
properties.currency

string

Валюта ISO, в которой взимается плата за метр, например, USD.
properties.endingBalance

number (decimal)

Конечный баланс для периода выставления счетов (для открытых периодов будет обновляться ежедневно).
properties.newPurchases

number (decimal)

Общая сумма покупки.
properties.newPurchasesDetails

NewPurchasesDetails[]

Список новых покупок.
properties.overageRefund

number (decimal)

Превышение стоимости возмещения
properties.priceHidden

boolean

Цена скрыта или нет.
properties.serviceOverage

number (decimal)

Превышение ресурсов для служб Azure.
properties.totalOverage

number (decimal)

serviceOverage + chargesBilledSeparately.
properties.totalUsage

number (decimal)

Обязательство службы Azure + общее превышение.
properties.utilized

number (decimal)

Общее использование обязательств.
tags

object

Теги ресурсов.
type

string

Тип ресурса.

BillingFrequency

Перечисление

Частота выставления счетов.

Значение Описание
Month
Quarter
Year

ErrorDetails

Object

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
message

string

Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.

  • Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.

Имя Тип Описание
error

ErrorDetails

Сведения об ошибке.

NewPurchasesDetails

Object

Список новых покупок.

Имя Тип Описание
name

string

имя новой покупки.
value

number (decimal)

значение новой покупки.