Billing Role Assignments - Create By Billing Account

サービス:

Billing

API バージョン:

2024-04-01

課金アカウントにロールの割り当てを追加します。 この操作は、契約の種類が Microsoft Partner Agreement または Microsoft 顧客契約の課金アカウントでサポートされています。

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment?api-version=2024-04-01

URI パラメーター

名前	/	必須	型	説明
billingAccountName	path	True	string pattern: ^([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})?)$	課金アカウントを一意に識別する ID。
api-version	query	True	string	クライアント要求で使用する API のバージョン。 現在のバージョンは 2024-04-01 です。

要求本文

名前	必須	型	説明
roleDefinitionId	True	string minLength: 1	ロール定義の ID。
principalId		string	ロールが割り当てられたユーザーのオブジェクト ID。
principalPuid		string	ロールが割り当てられたユーザーのプリンシパル PUID。
principalTenantId		string	ロールが割り当てられたユーザーのプリンシパル テナント ID。
scope		string	ロールが割り当てられたスコープ。
userAuthenticationType		string	ロールが割り当てられたユーザーの認証の種類 (組織または MSA) です。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。
userEmailAddress		string	ロールが割り当てられたユーザーの電子メール アドレス。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。

応答

名前	型	説明
200 OK	BillingRoleAssignment	課金ロールの割り当てのプロパティ。
202 Accepted		課金ロールの割り当てのプロパティ。 ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

BillingRoleAssignmentCreateByBillingAccount

要求のサンプル

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/createBillingRoleAssignment?api-version=2024-04-01

{
  "principalId": "00000000-0000-0000-0000-000000000000",
  "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
  "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
  "userEmailAddress": "john@contoso.com"
}

Java

import com.azure.resourcemanager.billing.models.BillingRoleAssignmentProperties;

/**
 * Samples for BillingRoleAssignments CreateByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentCreateByBillingAccount.json
     */
    /**
     * Sample code: BillingRoleAssignmentCreateByBillingAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentCreateByBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().createByBillingAccount(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
            new BillingRoleAssignmentProperties().withPrincipalId("00000000-0000-0000-0000-000000000000")
                .withPrincipalTenantId("076915e7-de10-4323-bb34-a58c904068bb")
                .withRoleDefinitionId(
                    "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000")
                .withUserEmailAddress("john@contoso.com"),
            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_create_by_billing_account.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.begin_create_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
        parameters={
            "principalId": "00000000-0000-0000-0000-000000000000",
            "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
            "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
            "userEmailAddress": "john@contoso.com",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.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/azcore/to"
	"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/billingRoleAssignmentCreateByBillingAccount.json
func ExampleRoleAssignmentsClient_BeginCreateByBillingAccount() {
	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)
	}
	poller, err := clientFactory.NewRoleAssignmentsClient().BeginCreateByBillingAccount(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", armbilling.RoleAssignmentProperties{
		PrincipalID:       to.Ptr("00000000-0000-0000-0000-000000000000"),
		PrincipalTenantID: to.Ptr("076915e7-de10-4323-bb34-a58c904068bb"),
		RoleDefinitionID:  to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000"),
		UserEmailAddress:  to.Ptr("john@contoso.com"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleAssignment = armbilling.RoleAssignment{
	// 	Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingRoleAssignments"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000"),
	// 	Properties: &armbilling.RoleAssignmentProperties{
	// 		CreatedByPrincipalID: to.Ptr("47309529-17e6-4104-b9e8-39f62fa1e5ed"),
	// 		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/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000"),
	// 		Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30"),
	// 	},
	// }
}

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 Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json
 */
async function billingRoleAssignmentCreateByBillingAccount() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
  const parameters = {
    principalId: "00000000-0000-0000-0000-000000000000",
    principalTenantId: "076915e7-de10-4323-bb34-a58c904068bb",
    roleDefinitionId:
      "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
    userEmailAddress: "john@contoso.com",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.beginCreateByBillingAccountAndWait(
    billingAccountName,
    parameters,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
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/billingRoleAssignmentCreateByBillingAccount.json
// this example is just showing the usage of "BillingRoleAssignments_CreateByBillingAccount" 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 BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// invoke the operation
BillingRoleAssignmentProperties billingRoleAssignmentProperties = new BillingRoleAssignmentProperties(new ResourceIdentifier("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000"))
{
    PrincipalId = "00000000-0000-0000-0000-000000000000",
    PrincipalTenantId = Guid.Parse("076915e7-de10-4323-bb34-a58c904068bb"),
    UserEmailAddress = "john@contoso.com",
};
ArmOperation<BillingRoleAssignmentData> lro = await billingAccount.CreateByBillingAccountBillingRoleAssignmentAsync(WaitUntil.Completed, billingRoleAssignmentProperties);
BillingRoleAssignmentData result = lro.Value;

// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {result.Id}");

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_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
  "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
  "properties": {
    "createdOn": "2023-10-19T20:10:50.1028398Z",
    "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
    "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
    "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
    "principalType": "User"
  },
  "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
}

状態コード:

202

location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01
retry-after: 5

定義

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

BillingRoleAssignment

Object

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

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース 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"

BillingRoleAssignmentProperties

Object

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

名前	型	説明
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 (date-time)	ロールの割り当てが作成された日付。
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 (date-time)	ロールの割り当てが変更された日付。
principalDisplayName	string	ロールが割り当てられたプリンシパルの表示名。
principalId	string	ロールが割り当てられたユーザーのオブジェクト ID。
principalPuid	string	ロールが割り当てられたユーザーのプリンシパル PUID。
principalTenantId	string	ロールが割り当てられたユーザーのプリンシパル テナント ID。
principalTenantName	string	ロールが割り当てられたユーザーのテナントのフレンドリ名。 これは、課金アカウントのプライマリ テナントの "プライマリ テナント" になります。
principalType	PrincipalType	ロールの割り当ての種類。
provisioningState	ProvisioningState	実行時間の長い操作中のリソースのプロビジョニング状態。
roleDefinitionId	string minLength: 1	ロール定義の ID。
scope	string	ロールが割り当てられたスコープ。
userAuthenticationType	string	ロールが割り当てられたユーザーの認証の種類 (組織または MSA) です。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。
userEmailAddress	string	ロールが割り当てられたユーザーの電子メール アドレス。 これは、契約の種類が Enterprise Agreement の請求先アカウントでのみサポートされます。

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

PrincipalType

列挙

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

値	説明
DirectoryRole
Everyone
Group
None
ServicePrincipal
Unknown
User

ProvisioningState

列挙

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

値	説明
Canceled
Failed
New
Pending
Provisioning
Succeeded

systemData

Object

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

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