Billing Accounts - List

リファレンス

サービス:: Billing

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

ユーザーがアクセスできる課金アカウントを一覧表示します。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01

省略可能なパラメーターを含む:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?includeAll={includeAll}&includeAllWithoutBillingProfiles={includeAllWithoutBillingProfiles}&includeDeleted={includeDeleted}&includePendingAgreement={includePendingAgreement}&includeResellee={includeResellee}&legalOwnerTID={legalOwnerTID}&legalOwnerOID={legalOwnerOID}&api-version=2024-04-01&filter={filter}&expand={expand}&top={top}&skip={skip}&search={search}

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在のバージョンは 2024-04-01 です。
expand	query		string	展開は、SoldTo と EnrollmentDetails/PONumber に対して許可されます。
filter	query		string	フィルタークエリオプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。
includeAll	query		boolean	true の場合、ユーザーが次のいずれかの AAD ロールを持っている場合、ユーザーが直接ロールの割り当てを持っていない課金アカウントが結果に含まれます:グローバル管理者、グローバル閲覧者、課金管理者。
includeAllWithoutBillingProfiles	query		boolean	true の場合、ユーザーが AAD ロール (グローバル管理者、グローバル閲覧者、課金管理者) のいずれかを持っている場合、完全には作成されない課金アカウントが結果に含まれます。
includeDeleted	query		boolean	true の場合、結果には、削除された状態の課金アカウントが含まれます。
includePendingAgreement	query		boolean	ユーザーがアクセスできる契約保留中の署名を持つ課金アカウントが含まれます。
includeResellee	query		boolean	ユーザーがアクセスできる Microsoft Partner Agreement の顧客の課金アカウントが含まれます。
legalOwnerOID	query		string	legalOwnerTID と組み合わせる必要があります。結果には、課金アカウントの法的責任を負う課金アカウントのみが含まれます。随意。
legalOwnerTID	query		string	legalOwnerOID と組み合わせる必要があります。結果には、課金アカウントに対して法的責任を負う課金アカウントのみが含まれます。随意。
search	query		string	検索クエリオプションを使用すると、クライアントは自由テキスト検索式に一致するコレクション内の項目を要求できます。検索は、文字列フィールドでのみサポートされています。
skip	query		integer int64	skip クエリオプションは、クエリ対象のコレクション内でスキップされ、結果に含まれない項目の数を要求します。
top	query		integer int64	上位のクエリオプションは、クエリされたコレクション内のアイテムの数を結果に含めるよう要求します。 top でサポートされる最大値は 50 です。

応答

名前	型	説明
200 OK	BillingAccountListResult	課金アカウントの一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

BillingAccountForLegacyAccountDetails

BillingAccountsList

BillingAccountsListWithExpandForPONumber

BillingAccountForLegacyAccountDetails

要求のサンプル

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01


/**
 * Samples for BillingAccounts List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingAccountForLegacyAccountDetails.json
     */
    /**
     * Sample code: BillingAccountForLegacyAccountDetails.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingAccountForLegacyAccountDetails(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingAccounts().list(null, null, null, null, null, null, null, null, null, null, null, null,
            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 billing_account_for_legacy_account_details.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.billing_accounts.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.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

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json
func ExampleAccountsClient_NewListPager_billingAccountForLegacyAccountDetails() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListPager(&armbilling.AccountsClientListOptions{IncludeAll: nil,
		IncludeAllWithoutBillingProfiles: nil,
		IncludeDeleted:                   nil,
		IncludePendingAgreement:          nil,
		IncludeResellee:                  nil,
		LegalOwnerTID:                    nil,
		LegalOwnerOID:                    nil,
		Filter:                           nil,
		Expand:                           nil,
		Top:                              nil,
		Skip:                             nil,
		Search:                           nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountListResult = armbilling.AccountListResult{
		// 	Value: []*armbilling.Account{
		// 		{
		// 			Name: to.Ptr("20000000-0000-0000-0000-000000000001"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001"),
		// 			Properties: &armbilling.AccountProperties{
		// 				AccountStatus: to.Ptr(armbilling.AccountStatusActive),
		// 				AccountType: to.Ptr(armbilling.AccountTypeIndividual),
		// 				AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftOnlineServicesProgram),
		// 				DisplayName: to.Ptr("Individual Account 2"),
		// 				HasReadAccess: to.Ptr(true),
		// 				NotificationEmailAddress: to.Ptr("individual@domain.com"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the billing accounts that a user has access to.
 *
 * @summary Lists the billing accounts that a user has access to.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json
 */
async function billingAccountForLegacyAccountDetails() {
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingAccounts.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/billingAccountForLegacyAccountDetails.json
// this example is just showing the usage of "BillingAccounts_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this BillingAccountResource
BillingAccountCollection collection = tenantResource.GetBillingAccounts();

// invoke the operation and iterate over the result
BillingAccountCollectionGetAllOptions options = new BillingAccountCollectionGetAllOptions() { };
await foreach (BillingAccountResource item in collection.GetAllAsync(options))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BillingAccountData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001",
      "name": "20000000-0000-0000-0000-000000000001",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "agreementType": "MicrosoftOnlineServicesProgram",
        "displayName": "Individual Account 2",
        "hasReadAccess": true,
        "notificationEmailAddress": "individual@domain.com"
      },
      "type": "Microsoft.Billing/billingAccounts"
    }
  ]
}