Billing Role Assignments - Create By Billing Account

Référence

Service:: Billing

Version d'API:: 2024-04-01

Ajoute une attribution de rôle sur un compte de facturation. L’opération est prise en charge pour les comptes de facturation avec le type contrat Partenaire Microsoft ou contrat client Microsoft.

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

Paramètres URI

Nom Dans Obligatoire Type Description

billingAccountName

path

True

string

ID qui identifie de façon unique un compte de facturation.

Modèle d’expression régulière: ^([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})?)$

api-version

query

True

string

Version de l’API à utiliser avec la demande cliente. La version actuelle est 2024-04-01.

Corps de la demande

Nom	Obligatoire	Type	Description
roleDefinitionId	True	string	ID de la définition de rôle.
principalId		string	ID d’objet de l’utilisateur auquel le rôle a été attribué.
principalPuid		string	PUID principal de l’utilisateur auquel le rôle a été attribué.
principalTenantId		string	ID de locataire principal de l’utilisateur auquel le rôle a été attribué.
scope		string	Étendue à laquelle le rôle a été attribué.
userAuthenticationType		string	Type d’authentification de l’utilisateur, qu’il s’agisse de l’organisation ou de msA, de l’utilisateur auquel le rôle a été attribué. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.
userEmailAddress		string	Adresse e-mail de l’utilisateur auquel le rôle a été attribué. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.

Réponses

Nom

Type

Description

200 OK

BillingRoleAssignment

Propriétés de l’attribution de rôle de facturation.

202 Accepted

Propriétés de l’attribution de rôle de facturation.

En-têtes

Location: string
Retry-After: integer

Other Status Codes

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

BillingRoleAssignmentCreateByBillingAccount

Exemple de requête

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


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

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

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

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

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

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 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

Définitions

Nom	Description
BillingRoleAssignment	Propriétés de l’attribution de rôle de facturation.
BillingRoleAssignmentProperties	Propriétés de l’attribution de rôle de facturation.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PrincipalType	Type d’attribution de rôle.
ProvisioningState	État d’approvisionnement de la ressource pendant une opération de longue durée.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

BillingRoleAssignment

Propriétés de l’attribution de rôle de facturation.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	BillingRoleAssignmentProperties	Propriétés de l’attribution de rôle de facturation.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Dictionnaire de métadonnées associées à la ressource. Il peut ne pas être rempli pour tous les types de ressources. Longueur maximale de clé/valeur prise en charge de 256 caractères. Les clés/valeur ne doivent pas être vides ni null. Les clés ne peuvent pas contenir <> % & \ ? /
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BillingRoleAssignmentProperties

Propriétés de l’attribution de rôle de facturation.

Nom	Type	Description
billingAccountDisplayName	string	Nom du compte de facturation.
billingAccountId	string	ID complet qui identifie de façon unique un compte de facturation.
billingProfileDisplayName	string	Nom du profil de facturation.
billingProfileId	string	ID complet qui identifie de façon unique un profil de facturation.
billingRequestId	string	ID de la demande de facturation créée pour l’attribution de rôle. Cela s’applique uniquement aux attributions de rôles entre locataires ou aux attributions de rôles créées par le biais de la demande de facturation.
createdByPrincipalId	string	ID d’objet de l’utilisateur qui a créé l’attribution de rôle.
createdByPrincipalPuid	string	PUID principal de l’utilisateur qui a créé l’attribution de rôle.
createdByPrincipalTenantId	string	ID de locataire de l’utilisateur qui a créé l’attribution de rôle.
createdByUserEmailAddress	string	Adresse e-mail de l’utilisateur qui a créé l’attribution de rôle. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.
createdOn	string	Date de création de l’attribution de rôle.
customerDisplayName	string	Nom du client.
customerId	string	ID complet qui identifie de façon unique un client.
invoiceSectionDisplayName	string	Nom de la section de facture.
invoiceSectionId	string	ID complet qui identifie de manière unique une section de facture.
modifiedByPrincipalId	string	PUID principal de l’utilisateur qui a modifié l’attribution de rôle.
modifiedByPrincipalPuid	string	PUID principal de l’utilisateur qui a modifié l’attribution de rôle.
modifiedByPrincipalTenantId	string	ID de locataire de l’utilisateur qui a modifié l’attribution de rôle.
modifiedByUserEmailAddress	string	Adresse e-mail de l’utilisateur qui a modifié l’attribution de rôle. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.
modifiedOn	string	Date de modification de l’attribution de rôle.
principalDisplayName	string	Nom complet du principal auquel le rôle a été attribué.
principalId	string	ID d’objet de l’utilisateur auquel le rôle a été attribué.
principalPuid	string	PUID principal de l’utilisateur auquel le rôle a été attribué.
principalTenantId	string	ID de locataire principal de l’utilisateur auquel le rôle a été attribué.
principalTenantName	string	Nom convivial du locataire de l’utilisateur auquel le rôle a été attribué. Il s’agit du « locataire principal » pour le locataire principal du compte de facturation.
principalType	PrincipalType	Type d’attribution de rôle.
provisioningState	ProvisioningState	État d’approvisionnement de la ressource pendant une opération de longue durée.
roleDefinitionId	string	ID de la définition de rôle.
scope	string	Étendue à laquelle le rôle a été attribué.
userAuthenticationType	string	Type d’authentification de l’utilisateur, qu’il s’agisse de l’organisation ou de msA, de l’utilisateur auquel le rôle a été attribué. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.
userEmailAddress	string	Adresse e-mail de l’utilisateur auquel le rôle a été attribué. Cela est pris en charge uniquement pour les comptes de facturation avec le type Contrat Entreprise de type Contrat Entreprise.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PrincipalType

Type d’attribution de rôle.

Nom	Type	Description
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

État d’approvisionnement de la ressource pendant une opération de longue durée.

Nom	Type	Description
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.