你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Balances - Get By Billing Account

按 billingAccountId 获取范围的余额。 余额仅适用于 2014 年 5 月 1 日或更高版本的此 API。

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

URI 参数

Name In Required Type Description
billingAccountId
path True
  • string

BillingAccount ID

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。 当前版本为 2021-10-01。

响应

Name Type Description
200 OK

没问题。 请求已成功。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Balances

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances?api-version=2021-10-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,
    "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”标头中指定的时间后重试。

NewPurchasesDetails

新购买的列表。

AdjustmentDetails

促销信用、SIE 信用等 (调整列表) 。

Name Type Description
name
  • string

新调整的名称。

value
  • number

新调整的值。

Balance

平衡资源。

Name Type Description
etag
  • string

资源的 etag。

id
  • string

事件的完整限定 ARM ID。

name
  • string

唯一标识事件的 ID。

properties.adjustmentDetails

促销信用、SIE 信用等 (调整列表) 。

properties.adjustments
  • number

总调整量。

properties.azureMarketplaceServiceCharges
  • number

Azure 市场的总费用。

properties.beginningBalance
  • number

计费周期的开始余额。

properties.billingFrequency

计费频率。

properties.chargesBilledSeparately
  • number

单独计费的费用。

properties.currency
  • string

计量费用的 ISO 货币,例如美元。

properties.endingBalance
  • number

计费周期的结束余额 (,这将每日更新) 。

properties.newPurchases
  • number

新购买金额总计。

properties.newPurchasesDetails

新购买的列表。

properties.priceHidden
  • boolean

价格是隐藏或不隐藏的。

properties.serviceOverage
  • number

Azure 服务的超额。

properties.totalOverage
  • number

serviceOverage + chargesBilledSeparately。

properties.totalUsage
  • number

Azure 服务承诺 + 总超额。

properties.utilized
  • number

承诺总使用量。

tags
  • object

资源标记。

type
  • string

资源类型。

BillingFrequency

计费频率。

Name Type Description
Month
  • string
Quarter
  • string
Year
  • string

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 在等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

Name Type Description
error

错误的详细信息。

NewPurchasesDetails

新购买的列表。

Name Type Description
name
  • string

新购买的名称。

value
  • number

新购买的值。