Available Balances - Get By Billing Profile

リファレンス

サービス:: Billing

API バージョン:: 2024-04-01

課金プロファイルのアカウント残高の利用可能なクレジットまたは支払い。クレジット残高は、期限切れまたは期限切れ請求書の決済に使用でき、契約の種類が Microsoft 顧客契約の請求先アカウントでサポートされます。アカウント残高の支払いは、契約の種類が Microsoft 顧客契約の請求先アカウントでサポートされています。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default?api-version=2024-04-01

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
billingAccountName	path	True	string	課金アカウントを一意に識別する ID。正規表現パターン: `^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$`
billingProfileName	path	True	string	課金プロファイルを一意に識別する ID。正規表現パターン: `^[a-zA-Z\d-_]{1,128}$`
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在のバージョンは 2024-04-01 です。

billingAccountName

path

True

string

課金アカウントを一意に識別する ID。

正規表現パターン: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$

billingProfileName

path

True

string

課金プロファイルを一意に識別する ID。

正規表現パターン: ^[a-zA-Z\d-_]{1,128}$

api-version

query

True

string

クライアント要求で使用する API のバージョン。現在のバージョンは 2024-04-01 です。

応答

名前	型	説明
200 OK	AvailableBalance	利用可能なクレジットまたは口座残高の支払い。クレジット残高は、支払期日または期限を過ぎた請求書の決済に使用できます。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

AvailableBalanceGetByBillingProfile

要求のサンプル

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default?api-version=2024-04-01


/**
 * Samples for AvailableBalances GetByBillingProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * availableBalanceGetByBillingProfile.json
     */
    /**
     * Sample code: AvailableBalanceGetByBillingProfile.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void availableBalanceGetByBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.availableBalances().getByBillingProfileWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python available_balance_get_by_billing_profile.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.available_balances.get_by_billing_profile(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json
 */
async function availableBalanceGetByBillingProfile() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.availableBalances.getByBillingProfile(
    billingAccountName,
    billingProfileName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json
// this example is just showing the usage of "AvailableBalances_GetByBillingProfile" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingProfileResource created on azure
// for more information of creating BillingProfileResource, please refer to the document of BillingProfileResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
ResourceIdentifier billingProfileResourceId = BillingProfileResource.CreateResourceIdentifier(billingAccountName, billingProfileName);
BillingProfileResource billingProfile = client.GetBillingProfileResource(billingProfileResourceId);

// invoke the operation
BillingAvailableBalanceData result = await billingProfile.GetBillingProfileAvailableBalanceAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default",
  "name": "default",
  "properties": {
    "amount": {
      "currency": "USD",
      "value": 500
    },
    "paymentsOnAccount": [
      {
        "amount": {
          "currency": "USD",
          "value": 50
        },
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Contoso Finance",
        "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
        "invoiceName": "G123456789",
        "date": "2024-04-01T00:00:00.0000000Z",
        "paymentMethodType": "CheckWire"
      }
    ],
    "totalPaymentsOnAccount": {
      "currency": "USD",
      "value": 200
    }
  },
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance"
}

定義

名前	説明
Amount	金額。
AvailableBalance	利用可能なクレジットまたは口座残高の支払い。クレジット残高は、支払期日または期限を過ぎた請求書の決済に使用できます。
AvailableBalanceProperties	利用可能なクレジットまたは口座残高の支払い。クレジット残高は、支払期日または期限を過ぎた請求書の決済に使用できます。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PaymentMethodFamily	アカウントの種類に対する支払い。
PaymentOnAccount	アカウントでの支払い。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TotalPaymentsOnAccount	アカウントに対する支払いの合計金額。

Amount

金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。たとえば、通貨が USD の場合、値 600 は $600.00 になります。