Billing Role Assignments - List By Customer

サービス:

Billing

API バージョン:

2024-04-01

顧客の呼び出し元のロールの割り当てを一覧表示します。 この操作は、契約の種類が Microsoft Partner Agreement の課金アカウントでサポートされています。

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

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

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments?api-version=2024-04-01&filter={filter}&top={top}&skip={skip}

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}$
customerName	path	True	string	顧客を一意に識別する ID。 正規表現パターン: ^[a-zA-Z\d-_]{1,128}$
api-version	query	True	string	クライアント要求で使用する API のバージョン。 現在のバージョンは 2024-04-01 です。
filter	query		string	フィルター クエリ オプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。
skip	query		integer int64	skip クエリ オプションは、クエリ対象のコレクション内でスキップされ、結果に含まれない項目の数を要求します。
top	query		integer int64	上位のクエリ オプションは、クエリされたコレクション内のアイテムの数を結果に含めるよう要求します。 top でサポートされる最大値は 50 です。

応答

名前	型	説明
200 OK	BillingRoleAssignmentListResult	課金ロールの割り当ての一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

BillingRoleAssignmentListByCustomer

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments?api-version=2024-04-01

Java

/**
 * Samples for BillingRoleAssignments ListByCustomer.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentListByCustomer.json
     */
    /**
     * Sample code: BillingRoleAssignmentListByCustomer.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingRoleAssignmentListByCustomer(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().listByCustomer(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "BKM6-54VH-BG7-PGB",
            "703ab484-dda2-4402-827b-a74513b61e2d", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_role_assignment_list_by_customer.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_role_assignments.list_by_customer(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
        billing_profile_name="BKM6-54VH-BG7-PGB",
        customer_name="703ab484-dda2-4402-827b-a74513b61e2d",
    )
    for item in response:
        print(item)


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

Go

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/billingRoleAssignmentListByCustomer.json
func ExampleRoleAssignmentsClient_NewListByCustomerPager() {
	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.NewRoleAssignmentsClient().NewListByCustomerPager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "BKM6-54VH-BG7-PGB", "703ab484-dda2-4402-827b-a74513b61e2d", &armbilling.RoleAssignmentsClientListByCustomerOptions{Filter: nil,
		Top:  nil,
		Skip: 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.RoleAssignmentListResult = armbilling.RoleAssignmentListResult{
		// 	Value: []*armbilling.RoleAssignment{
		// 		{
		// 			Name: to.Ptr("30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr(""),
		// 				CreatedByPrincipalTenantID: to.Ptr("076915e7-de10-4323-bb34-a58c904068bb"),
		// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-19T20:10:50.102Z"); return t}()),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				PrincipalType: to.Ptr(armbilling.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr(""),
		// 				CreatedByPrincipalTenantID: to.Ptr("076915e7-de10-4323-bb34-a58c904068bb"),
		// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-19T20:10:50.102Z"); return t}()),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				PrincipalType: to.Ptr(armbilling.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json
 */
async function billingRoleAssignmentListByCustomer() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
  const billingProfileName = "BKM6-54VH-BG7-PGB";
  const customerName = "703ab484-dda2-4402-827b-a74513b61e2d";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingRoleAssignments.listByCustomer(
    billingAccountName,
    billingProfileName,
    customerName,
  )) {
    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

dotnet

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

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json
// this example is just showing the usage of "BillingRoleAssignments_ListByCustomer" 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 BillingProfileCustomerResource created on azure
// for more information of creating BillingProfileCustomerResource, please refer to the document of BillingProfileCustomerResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
string billingProfileName = "BKM6-54VH-BG7-PGB";
string customerName = "703ab484-dda2-4402-827b-a74513b61e2d";
ResourceIdentifier billingProfileCustomerResourceId = BillingProfileCustomerResource.CreateResourceIdentifier(billingAccountName, billingProfileName, customerName);
BillingProfileCustomerResource billingProfileCustomer = client.GetBillingProfileCustomerResource(billingProfileCustomerResourceId);

// get the collection of this BillingCustomerRoleAssignmentResource
BillingCustomerRoleAssignmentCollection collection = billingProfileCustomer.GetBillingCustomerRoleAssignments();

// invoke the operation and iterate over the result
await foreach (BillingCustomerRoleAssignmentResource item in collection.GetAllAsync())
{
    // 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
    BillingRoleAssignmentData 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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments"
    }
  ]
}

定義

名前	説明
BillingRoleAssignment	課金ロールの割り当てのプロパティ。
BillingRoleAssignmentListResult	リソースの一覧のコンテナー
BillingRoleAssignmentProperties	課金ロールの割り当てのプロパティ。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PrincipalType	ロールの割り当ての種類。
ProvisioningState	実行時間の長い操作中のリソースのプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

BillingRoleAssignment

課金ロールの割り当てのプロパティ。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	BillingRoleAssignmentProperties	課金ロールの割り当てのプロパティ。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースに関連付けられているメタデータのディクショナリ。 リソースの種類によっては設定されない場合があります。 キー/値の最大長は 256 文字でサポートされます。 キー/値は、値を空にしたり、null にしたりしないでください。 キーは <> % &\ を含むできませんか? /
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentListResult

リソースの一覧のコンテナー

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
value	BillingRoleAssignment[]	リソースの一覧。

BillingRoleAssignmentProperties

課金ロールの割り当てのプロパティ。

名前	型	説明
billingAccountDisplayName	string	課金アカウントの名前。
billingAccountId	string	課金アカウントを一意に識別する完全修飾 ID。
billingProfileDisplayName	string	課金プロファイルの名前。
billingProfileId	string	課金プロファイルを一意に識別する完全修飾 ID。
billingRequestId	string	ロールの割り当てに対して作成された課金要求の ID。 これは、テナント間のロールの割り当てまたは課金要求によって作成されたロールの割り当てにのみ適用されます。
createdByPrincipalId	string	ロールの割り当てを作成したユーザーのオブジェクト ID。
createdByPrincipalPuid	string	ロールの割り当てを作成したユーザーのプリンシパル PUID。
createdByPrincipalTenantId	string	ロールの割り当てを作成したユーザーのテナント ID。
createdByUserEmailAddress	string	ロールの割り当てを作成したユーザーの電子メール アドレス。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。
createdOn	string	ロールの割り当てが作成された日付。
customerDisplayName	string	顧客の名前。
customerId	string	顧客を一意に識別する完全修飾 ID。
invoiceSectionDisplayName	string	請求書セクションの名前。
invoiceSectionId	string	請求書セクションを一意に識別する完全修飾 ID。
modifiedByPrincipalId	string	ロールの割り当てを変更したユーザーのプリンシパル PUID。
modifiedByPrincipalPuid	string	ロールの割り当てを変更したユーザーのプリンシパル PUID。
modifiedByPrincipalTenantId	string	ロールの割り当てを変更したユーザーのテナント ID。
modifiedByUserEmailAddress	string	ロールの割り当てを変更したユーザーの電子メール アドレス。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。
modifiedOn	string	ロールの割り当てが変更された日付。
principalDisplayName	string	ロールが割り当てられたプリンシパルの表示名。
principalId	string	ロールが割り当てられたユーザーのオブジェクト ID。
principalPuid	string	ロールが割り当てられたユーザーのプリンシパル PUID。
principalTenantId	string	ロールが割り当てられたユーザーのプリンシパル テナント ID。
principalTenantName	string	ロールが割り当てられたユーザーのテナントのフレンドリ名。 これは、課金アカウントのプライマリ テナントの "プライマリ テナント" になります。
principalType	PrincipalType	ロールの割り当ての種類。
provisioningState	ProvisioningState	実行時間の長い操作中のリソースのプロビジョニング状態。
roleDefinitionId	string	ロール定義の ID。
scope	string	ロールが割り当てられたスコープ。
userAuthenticationType	string	ロールが割り当てられたユーザーの認証の種類 (組織または MSA) です。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。
userEmailAddress	string	ロールが割り当てられたユーザーの電子メール アドレス。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

PrincipalType

ロールの割り当ての種類。

名前	型	説明
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

実行時間の長い操作中のリソースのプロビジョニング状態。

名前	型	説明
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。