Balances - Get For Billing Period By Billing Account

リファレンス

Service:: Consumption

API Version:: 2023-05-01

請求期間と billingAccountId によるスコープの残高を取得します。残高は、2014 年 5 月 1 日以降にのみ、この API を介して利用できます。

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

URI パラメーター

名前	/	必須	型	説明
billingAccountId	path	True	string	BillingAccount ID
billingPeriodName	path	True	string	請求期間名。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2023-03-01 です。

応答

名前	型	説明
200 OK	Balance	OK です。要求は成功しました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Balances

Sample Request

HTTP

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

Sample Response

Status code:: 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" ヘッダーで指定された時刻まで待ってから、再試行してください。
NewPurchasesDetails	新しい購入の一覧。

AdjustmentDetails

調整の一覧 (プロモーションクレジット、SIE クレジットなど)。

名前	型	説明
name	string	新しい調整の名前。
value	number	新しい調整の値。

Balance

バランスリソース。

名前	型	説明
etag	string	リソースの etag。
id	string	イベントの完全修飾 ARM ID。
name	string	イベントを一意に識別する ID。
properties.adjustmentDetails	AdjustmentDetails[]	調整の一覧 (プロモーションクレジット、SIE クレジットなど)。
properties.adjustments	number	調整金額の合計。
properties.azureMarketplaceServiceCharges	number	Azure Marketplaceの合計料金。
properties.beginningBalance	number	請求期間の開始残高。
properties.billingFrequency	BillingFrequency	課金頻度。
properties.chargesBilledSeparately	number	料金は別途請求されます。
properties.currency	string	メーターが課金される ISO 通貨 (たとえば、米国ドル)。
properties.endingBalance	number	請求期間の終了残高 (オープン期間の場合、これは毎日更新されます)。
properties.newPurchases	number	新しい購入金額の合計。
properties.newPurchasesDetails	NewPurchasesDetails[]	新しい購入の一覧。
properties.overageRefund	number	超過分の払い戻し
properties.priceHidden	boolean	価格が非表示かどうか。
properties.serviceOverage	number	Azure サービスの超過。
properties.totalOverage	number	serviceOverage + chargesBilledSeparately。
properties.totalUsage	number	Azure サービスコミットメント + 合計超過分。
properties.utilized	number	コミットメントの合計使用量。
tags	object	リソースタグ。
type	string	リソースの種類。

BillingFrequency

課金頻度。

名前	型	説明
Month	string
Quarter	string
Year	string

ErrorDetails

エラーの詳細。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに示されています。

いくつかのエラー応答:

429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

名前	型	説明
error	ErrorDetails	エラーの詳細。

NewPurchasesDetails

新しい購入の一覧。

名前	型	説明
name	string	新しい購入の名前。
value	number	新しい購入の価値。

次の方法で共有