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

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

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
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 
{
  "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
  }
}

Определения

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

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

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

Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

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

Ответ на ошибку
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Balance

Object

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

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

string

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

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.adjustmentDetails

BalancePropertiesAdjustmentDetailsItem[]

Список корректировк (промо-кредит, кредит 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

BalancePropertiesNewPurchasesDetailsItem[]

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

number (decimal)

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

boolean

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

number (decimal)

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

number (decimal)

serviceOverage + chargesBilledSeparate.
properties.totalUsage

number (decimal)

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

number (decimal)

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

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags

object

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

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BalancePropertiesAdjustmentDetailsItem

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

string

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

number (decimal)

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

BalancePropertiesNewPurchasesDetailsItem

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

string

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

number (decimal)

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

BillingFrequency

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

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

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

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

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

ErrorDetail

Объект ошибки.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

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

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.