Billing Role Assignments - Create Or Update By Billing Account

서비스:

Billing

API 버전:

2024-04-01

청구 역할 할당을 만들거나 업데이트합니다. 이 작업은 계약 유형 기업계약이 있는 청구 계정에 대해서만 지원됩니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
billingAccountName	path	True	string	청구 계정을 고유하게 식별하는 ID입니다. regex 패턴: ^([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})?)$
billingRoleAssignmentName	path	True	string	역할 할당을 고유하게 식별하는 ID입니다. regex 패턴: ^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2024-04-01입니다.

요청 본문

Name	형식	Description
properties	BillingRoleAssignmentProperties	청구 역할 할당의 속성입니다.
tags	object	리소스와 연결된 메타데이터의 사전입니다. 모든 리소스 종류에 대해 채워지지 않을 수 있습니다. 최대 키/값 길이는 256자로 지원됩니다. 키/값은 값이나 null을 비워서는 안 됩니다. 키에는 <> % & \ ? /

응답

Name	형식	Description
200 OK	BillingRoleAssignment	청구 역할 할당의 속성입니다.
201 Created	BillingRoleAssignment	청구 역할 할당의 속성입니다. 헤더 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

예제

BillingRoleAssignmentCreateOrUpdateByBillingAccount

샘플 요청

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402?api-version=2024-04-01

{
  "properties": {
    "principalId": "00000000-0000-0000-0000-000000000000",
    "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
    "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "userEmailAddress": "john@contoso.com"
  }
}

Java

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

/**
 * Samples for BillingRoleAssignments CreateOrUpdateByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentCreateOrUpdateByBillingAccount.json
     */
    /**
     * Sample code: BillingRoleAssignmentCreateOrUpdateByBillingAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentCreateOrUpdateByBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().createOrUpdateByBillingAccount("7898901",
            "9dfd08c2-62a3-4d47-85bd-1cdba1408402",
            new BillingRoleAssignmentInner().withProperties(new BillingRoleAssignmentProperties()
                .withPrincipalId("00000000-0000-0000-0000-000000000000")
                .withPrincipalTenantId("076915e7-de10-4323-bb34-a58c904068bb")
                .withRoleDefinitionId(
                    "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db")
                .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_or_update_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_or_update_by_billing_account(
        billing_account_name="7898901",
        billing_role_assignment_name="9dfd08c2-62a3-4d47-85bd-1cdba1408402",
        parameters={
            "properties": {
                "principalId": "00000000-0000-0000-0000-000000000000",
                "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
                "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
                "userEmailAddress": "john@contoso.com",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.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/billingRoleAssignmentCreateOrUpdateByBillingAccount.json
func ExampleRoleAssignmentsClient_BeginCreateOrUpdateByBillingAccount() {
	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().BeginCreateOrUpdateByBillingAccount(ctx, "7898901", "9dfd08c2-62a3-4d47-85bd-1cdba1408402", armbilling.RoleAssignment{
		Properties: &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/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db"),
			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("9dfd08c2-62a3-4d47-85bd-1cdba1408402"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingRoleAssignments"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402"),
	// 	Properties: &armbilling.RoleAssignmentProperties{
	// 		CreatedByPrincipalID: to.Ptr("60d97094-2be4-46cc-a4fe-3633021a25b9"),
	// 		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"),
	// 		PrincipalTenantID: to.Ptr("7ca289b9-c32d-4f01-8566-7ff93261d76f"),
	// 		RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db"),
	// 		Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901"),
	// 	},
	// }
}

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 Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
 *
 * @summary Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json
 */
async function billingRoleAssignmentCreateOrUpdateByBillingAccount() {
  const billingAccountName = "7898901";
  const billingRoleAssignmentName = "9dfd08c2-62a3-4d47-85bd-1cdba1408402";
  const parameters = {
    properties: {
      principalId: "00000000-0000-0000-0000-000000000000",
      principalTenantId: "076915e7-de10-4323-bb34-a58c904068bb",
      roleDefinitionId:
        "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
      userEmailAddress: "john@contoso.com",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.beginCreateOrUpdateByBillingAccountAndWait(
    billingAccountName,
    billingRoleAssignmentName,
    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.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/billingRoleAssignmentCreateOrUpdateByBillingAccount.json
// this example is just showing the usage of "BillingRoleAssignments_CreateOrUpdateByBillingAccount" 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 BillingRoleAssignmentResource created on azure
// for more information of creating BillingRoleAssignmentResource, please refer to the document of BillingRoleAssignmentResource
string billingAccountName = "7898901";
string billingRoleAssignmentName = "9dfd08c2-62a3-4d47-85bd-1cdba1408402";
ResourceIdentifier billingRoleAssignmentResourceId = BillingRoleAssignmentResource.CreateResourceIdentifier(billingAccountName, billingRoleAssignmentName);
BillingRoleAssignmentResource billingRoleAssignment = client.GetBillingRoleAssignmentResource(billingRoleAssignmentResourceId);

// invoke the operation
BillingRoleAssignmentData data = new BillingRoleAssignmentData()
{
    Properties = new BillingRoleAssignmentProperties(new ResourceIdentifier("/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db"))
    {
        PrincipalId = "00000000-0000-0000-0000-000000000000",
        PrincipalTenantId = Guid.Parse("076915e7-de10-4323-bb34-a58c904068bb"),
        UserEmailAddress = "john@contoso.com",
    },
};
ArmOperation<BillingRoleAssignmentResource> lro = await billingRoleAssignment.UpdateAsync(WaitUntil.Completed, data);
BillingRoleAssignmentResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.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/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "properties": {
    "createdOn": "2023-10-19T20:10:50.1028398Z",
    "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
    "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
    "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "scope": "/providers/Microsoft.Billing/billingAccounts/7898901"
  },
  "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
}

상태 코드:

201

{
  "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "properties": {
    "createdOn": "2023-10-19T20:10:50.1028398Z",
    "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
    "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
    "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "scope": "/providers/Microsoft.Billing/billingAccounts/7898901"
  },
  "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments"
}

정의

Name	Description
BillingRoleAssignment	청구 역할 할당의 속성입니다.
BillingRoleAssignmentProperties	청구 역할 할당의 속성입니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
PrincipalType	역할 할당의 유형입니다.
ProvisioningState	장기 실행 작업 중 리소스의 프로비전 상태입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

BillingRoleAssignment

청구 역할 할당의 속성입니다.

Name	형식	Description
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"

BillingRoleAssignmentProperties

청구 역할 할당의 속성입니다.

Name	형식	Description
billingAccountDisplayName	string	청구 계정의 이름입니다.
billingAccountId	string	청구 계정을 고유하게 식별하는 정규화된 ID입니다.
billingProfileDisplayName	string	청구 프로필의 이름입니다.
billingProfileId	string	청구 프로필을 고유하게 식별하는 정규화된 ID입니다.
billingRequestId	string	역할 할당에 대해 생성된 청구 요청의 ID입니다. 이는 청구 요청을 통해 만든 교차 테넌트 역할 할당 또는 역할 할당에만 적용됩니다.
createdByPrincipalId	string	역할 할당을 만든 사용자의 개체 ID입니다.
createdByPrincipalPuid	string	역할 할당을 만든 사용자의 주요 PUID입니다.
createdByPrincipalTenantId	string	역할 할당을 만든 사용자의 테넌트 ID입니다.
createdByUserEmailAddress	string	역할 할당을 만든 사용자의 이메일 주소입니다. 이는 규약 유형 기업계약이 있는 청구 계정에 대해서만 지원됩니다.
createdOn	string	역할 할당이 만들어진 날짜입니다.
customerDisplayName	string	고객의 이름입니다.
customerId	string	고객을 고유하게 식별하는 정규화된 ID입니다.
invoiceSectionDisplayName	string	청구서 섹션의 이름입니다.
invoiceSectionId	string	청구서 섹션을 고유하게 식별하는 정규화된 ID입니다.
modifiedByPrincipalId	string	역할 할당을 수정한 사용자의 주요 PUID입니다.
modifiedByPrincipalPuid	string	역할 할당을 수정한 사용자의 주요 PUID입니다.
modifiedByPrincipalTenantId	string	역할 할당을 수정한 사용자의 테넌트 ID입니다.
modifiedByUserEmailAddress	string	역할 할당을 수정한 사용자의 이메일 주소입니다. 이는 규약 유형 기업계약이 있는 청구 계정에 대해서만 지원됩니다.
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)입니다. 이는 규약 유형 기업계약이 있는 청구 계정에 대해서만 지원됩니다.
userEmailAddress	string	역할이 할당된 사용자의 이메일 주소입니다. 이는 규약 유형 기업계약이 있는 청구 계정에 대해서만 지원됩니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

PrincipalType

역할 할당의 유형입니다.

Name	형식	Description
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

장기 실행 작업 중 리소스의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.