Billing Role Assignments - Create Or Update By Enrollment Account

Başvuru

Hizmet:: Billing

API Sürümü:: 2024-04-01

Faturalama rolü ataması oluşturun veya güncelleştirin. bu işlem yalnızca Kurumsal Anlaşma sözleşme türündeki ödeme hesapları için desteklenir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
billingAccountName	path	True	string	Bir ödeme hesabını benzersiz olarak tanımlayan kimlik. Normal ifade deseni: `^([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	Rol atamasını benzersiz olarak tanımlayan kimlik. Normal ifade deseni: `^[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})?$`
enrollmentAccountName	path	True	string	Kayıt hesabının adı. Normal ifade deseni: `^[a-zA-Z\d-_]{1,128}$`
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü. Geçerli sürüm 2024-04-01'dir.

İstek Gövdesi

Name	Tür	Description
properties	BillingRoleAssignmentProperties	Faturalama rolü atamasının özellikleri.
tags	object	Kaynakla ilişkilendirilmiş meta verilerin sözlüğü. Tüm kaynak türleri için doldurulmayabilir. Desteklenen en fazla anahtar/değer uzunluğu 256 karakterdir. Anahtarlar/değer boş değer veya null olmamalıdır. Anahtarlar <> % & \ ? içeremez /

Yanıtlar

Name

Tür

Description

200 OK

BillingRoleAssignment

Faturalama rolü atamasının özellikleri.

201 Created

BillingRoleAssignment

Faturalama rolü atamasının özellikleri.

Üst Bilgiler

Location: string
Retry-After: integer

Other Status Codes

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount

Örnek isteği

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/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/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "userEmailAddress": "john@contoso.com"
  }
}


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

/**
 * Samples for BillingRoleAssignments CreateOrUpdateByEnrollmentAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json
     */
    /**
     * Sample code: BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingRoleAssignmentCreateOrUpdateByEnrollmentAccount(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().createOrUpdateByEnrollmentAccount("7898901", "123456",
            "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/enrollmentAccounts/123456/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

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_enrollment_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_enrollment_account(
        billing_account_name="7898901",
        enrollment_account_name="123456",
        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/enrollmentAccounts/123456/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/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.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/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/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json
func ExampleRoleAssignmentsClient_BeginCreateOrUpdateByEnrollmentAccount() {
	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().BeginCreateOrUpdateByEnrollmentAccount(ctx, "7898901", "123456", "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/enrollmentAccounts/123456/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/enrollmentAccounts/billingRoleAssignments"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/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/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db"),
	// 		Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456"),
	// 	},
	// }
}

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 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/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json
 */
async function billingRoleAssignmentCreateOrUpdateByEnrollmentAccount() {
  const billingAccountName = "7898901";
  const enrollmentAccountName = "123456";
  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/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
      userEmailAddress: "john@contoso.com",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.beginCreateOrUpdateByEnrollmentAccountAndWait(
    billingAccountName,
    enrollmentAccountName,
    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

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/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json
// this example is just showing the usage of "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount" 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://video2.skills-academy.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 BillingEnrollmentAccountRoleAssignmentResource created on azure
// for more information of creating BillingEnrollmentAccountRoleAssignmentResource, please refer to the document of BillingEnrollmentAccountRoleAssignmentResource
string billingAccountName = "7898901";
string enrollmentAccountName = "123456";
string billingRoleAssignmentName = "9dfd08c2-62a3-4d47-85bd-1cdba1408402";
ResourceIdentifier billingEnrollmentAccountRoleAssignmentResourceId = BillingEnrollmentAccountRoleAssignmentResource.CreateResourceIdentifier(billingAccountName, enrollmentAccountName, billingRoleAssignmentName);
BillingEnrollmentAccountRoleAssignmentResource billingEnrollmentAccountRoleAssignment = client.GetBillingEnrollmentAccountRoleAssignmentResource(billingEnrollmentAccountRoleAssignmentResourceId);

// invoke the operation
BillingRoleAssignmentData data = new BillingRoleAssignmentData()
{
    Properties = new BillingRoleAssignmentProperties(new ResourceIdentifier("/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/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<BillingEnrollmentAccountRoleAssignmentResource> lro = await billingEnrollmentAccountRoleAssignment.UpdateAsync(WaitUntil.Completed, data);
BillingEnrollmentAccountRoleAssignmentResource 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

Örnek yanıt

Durum kodu:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/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/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456"
  },
  "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
}

Durum kodu:: 201

{
  "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/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/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
    "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456"
  },
  "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
}

Tanımlar

Name	Description
BillingRoleAssignment	Faturalama rolü atamasının özellikleri.
BillingRoleAssignmentProperties	Faturalama rolü atamasının özellikleri.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
PrincipalType	Rol Ataması türü.
ProvisioningState	Uzun süre çalışan bir işlem sırasında kaynağın sağlama durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

BillingRoleAssignment

Faturalama rolü atamasının özellikleri.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties	BillingRoleAssignmentProperties	Faturalama rolü atamasının özellikleri.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
tags	object	Kaynakla ilişkilendirilmiş meta verilerin sözlüğü. Tüm kaynak türleri için doldurulmayabilir. Desteklenen en fazla anahtar/değer uzunluğu 256 karakterdir. Anahtarlar/değer boş değer veya null olmamalıdır. Anahtarlar <> % & \ ? içeremez /
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentProperties

Faturalama rolü atamasının özellikleri.

Name	Tür	Description
billingAccountDisplayName	string	Ödeme hesabının adı.
billingAccountId	string	Bir ödeme hesabını benzersiz olarak tanımlayan tam kimlik.
billingProfileDisplayName	string	Faturalama profilinin adı.
billingProfileId	string	Faturalama profilini benzersiz olarak tanımlayan tam kimlik.
billingRequestId	string	Rol ataması için oluşturulan faturalama isteğinin kimliği. Bu yalnızca faturalama isteği aracılığıyla oluşturulan kiracılar arası rol atamaları veya rol atamaları için geçerlidir.
createdByPrincipalId	string	Rol atamasını oluşturan kullanıcının nesne kimliği.
createdByPrincipalPuid	string	Rol atamasını oluşturan kullanıcının asıl PUID değeri.
createdByPrincipalTenantId	string	Rol atamasını oluşturan kullanıcının kiracı kimliği.
createdByUserEmailAddress	string	Rol atamasını oluşturan kullanıcının e-posta adresi. Bu yalnızca anlaşma türü Kurumsal Anlaşma olan ödeme hesapları için desteklenir.
createdOn	string	Rol atamasının oluşturulduğu tarih.
customerDisplayName	string	Müşterinin adı.
customerId	string	Bir müşteriyi benzersiz olarak tanımlayan tam kimlik.
invoiceSectionDisplayName	string	Fatura bölümünün adı.
invoiceSectionId	string	Bir fatura bölümünü benzersiz olarak tanımlayan tam kimlik.
modifiedByPrincipalId	string	Rol atamasını değiştiren kullanıcının asıl PUID değeri.
modifiedByPrincipalPuid	string	Rol atamasını değiştiren kullanıcının asıl PUID değeri.
modifiedByPrincipalTenantId	string	Rol atamasını değiştiren kullanıcının kiracı kimliği.
modifiedByUserEmailAddress	string	Rol atamasını değiştiren kullanıcının e-posta adresi. Bu yalnızca anlaşma türü Kurumsal Anlaşma olan ödeme hesapları için desteklenir.
modifiedOn	string	Rol atamasının değiştirildiği tarih.
principalDisplayName	string	Rolün atandığı sorumlunun görünen adı.
principalId	string	Rolün atandığı kullanıcının nesne kimliği.
principalPuid	string	Rolün atandığı kullanıcının asıl PUID değeri.
principalTenantId	string	Rolün atandığı kullanıcının asıl kiracı kimliği.
principalTenantName	string	Rolün atandığı kullanıcının kiracısının kolay adı. Bu, ödeme hesabının birincil kiracısı için 'Birincil Kiracı' olacaktır.
principalType	PrincipalType	Rol Ataması türü.
provisioningState	ProvisioningState	Uzun süre çalışan bir işlem sırasında kaynağın sağlama durumu.
roleDefinitionId	string	Rol tanımının kimliği.
scope	string	Rolün atandığı kapsam.
userAuthenticationType	string	Rolün atandığı kullanıcının kuruluş veya MSA kimlik doğrulama türü. Bu yalnızca anlaşma türü Kurumsal Anlaşma olan ödeme hesapları için desteklenir.
userEmailAddress	string	Rolün atandığı kullanıcının e-posta adresi. Bu yalnızca anlaşma türü Kurumsal Anlaşma olan ödeme hesapları için desteklenir.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

PrincipalType

Rol Ataması türü.

Name	Tür	Description
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

Uzun süre çalışan bir işlem sırasında kaynağın sağlama durumu.

Name	Tür	Description
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.