Billing Role Assignments - Create Or Update By Enrollment Account

Služba:

Billing

Verze rozhraní API:

2024-04-01

Vytvoření nebo aktualizace přiřazení fakturační role Operace se podporuje jenom u fakturačních účtů s typem smlouvy Enterprise.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingAccountName	path	True	string	ID, které jednoznačně identifikuje fakturační účet. Vzor regulárního výrazu: ^([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, které jednoznačně identifikuje přiřazení role. Vzor regulárního výrazu: ^[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	Název registračního účtu. Vzor regulárního výrazu: ^[a-zA-Z\d-_]{1,128}$
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2024-04-01.

Text požadavku

Name	Typ	Description
properties	BillingRoleAssignmentProperties	Vlastnosti přiřazení fakturační role.
tags	object	Slovník metadat přidružených k prostředku Nemusí být vyplněna pro všechny typy prostředků. Maximální podporovaná délka klíče a hodnoty 256 znaků. Klíče nebo hodnota by neměly být prázdné ani null. Klíče nemohou obsahovat <> % & \ ? /

Odpovědi

Name	Typ	Description
200 OK	BillingRoleAssignment	Vlastnosti přiřazení fakturační role.
201 Created	BillingRoleAssignment	Vlastnosti přiřazení fakturační role. Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount

Ukázkový požadavek

HTTP

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"
  }
}

Java

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

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_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

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/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

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/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

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/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://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 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

Ukázková odpověď

Stavový kód:

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"
}

Stavový kód:

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"
}

Definice

Name	Description
BillingRoleAssignment	Vlastnosti přiřazení fakturační role.
BillingRoleAssignmentProperties	Vlastnosti přiřazení fakturační role.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
PrincipalType	Typ přiřazení role.
ProvisioningState	Stav zřizování prostředku během dlouhotrvající operace.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

BillingRoleAssignment

Vlastnosti přiřazení fakturační role.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	BillingRoleAssignmentProperties	Vlastnosti přiřazení fakturační role.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Slovník metadat přidružených k prostředku Nemusí být vyplněna pro všechny typy prostředků. Maximální podporovaná délka klíče a hodnoty 256 znaků. Klíče nebo hodnota by neměly být prázdné ani null. Klíče nemohou obsahovat <> % & \ ? /
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BillingRoleAssignmentProperties

Vlastnosti přiřazení fakturační role.

Name	Typ	Description
billingAccountDisplayName	string	Název fakturačního účtu.
billingAccountId	string	Plně kvalifikované ID, které jednoznačně identifikuje fakturační účet.
billingProfileDisplayName	string	Název fakturačního profilu.
billingProfileId	string	Plně kvalifikované ID, které jednoznačně identifikuje fakturační profil.
billingRequestId	string	ID žádosti o fakturaci vytvořené pro přiřazení role. To platí jenom pro přiřazení rolí mezi tenanty nebo přiřazení rolí vytvořených prostřednictvím žádosti o fakturaci.
createdByPrincipalId	string	ID objektu uživatele, který vytvořil přiřazení role.
createdByPrincipalPuid	string	Hlavní PUID uživatele, který vytvořil přiřazení role.
createdByPrincipalTenantId	string	ID tenanta uživatele, který vytvořil přiřazení role.
createdByUserEmailAddress	string	E-mailová adresa uživatele, který vytvořil přiřazení role. To se podporuje jenom u fakturačních účtů s typem smlouvy Enterprise.
createdOn	string	Datum vytvoření přiřazení role.
customerDisplayName	string	Jméno zákazníka.
customerId	string	Plně kvalifikované ID, které jednoznačně identifikuje zákazníka.
invoiceSectionDisplayName	string	Název oddílu faktury.
invoiceSectionId	string	Plně kvalifikované ID, které jednoznačně identifikuje oddíl faktury.
modifiedByPrincipalId	string	Hlavní PUID uživatele, který změnil přiřazení role.
modifiedByPrincipalPuid	string	Hlavní PUID uživatele, který změnil přiřazení role.
modifiedByPrincipalTenantId	string	ID tenanta uživatele, který změnil přiřazení role.
modifiedByUserEmailAddress	string	E-mailová adresa uživatele, který změnil přiřazení role. To se podporuje jenom u fakturačních účtů s typem smlouvy Enterprise.
modifiedOn	string	Datum změny přiřazení role.
principalDisplayName	string	Zobrazovaný název objektu zabezpečení, kterému byla role přiřazena.
principalId	string	ID objektu uživatele, kterému byla role přiřazena.
principalPuid	string	Hlavní PUID uživatele, kterému byla role přiřazena.
principalTenantId	string	ID hlavního tenanta uživatele, kterému byla role přiřazena.
principalTenantName	string	Popisný název tenanta uživatele, kterému byla role přiřazena. Bude to primární tenant pro primárního tenanta fakturačního účtu.
principalType	PrincipalType	Typ přiřazení role.
provisioningState	ProvisioningState	Stav zřizování prostředku během dlouhotrvající operace.
roleDefinitionId	string	ID definice role.
scope	string	Obor, ke kterému byla role přiřazena.
userAuthenticationType	string	Typ ověřování uživatele, ať už organizace nebo msa, uživatele, kterému byla role přiřazena. To se podporuje jenom u fakturačních účtů s typem smlouvy Enterprise.
userEmailAddress	string	E-mailová adresa uživatele, kterému byla role přiřazena. To se podporuje jenom u fakturačních účtů s typem smlouvy Enterprise.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PrincipalType

Typ přiřazení role.

Name	Typ	Description
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

Stav zřizování prostředku během dlouhotrvající operace.

Name	Typ	Description
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.