Billing Role Assignments - Create Or Update By Billing Account

Servizio:

Billing

Versione API:

2024-04-01

Creare o aggiornare un'assegnazione di ruolo di fatturazione. L'operazione è supportata solo per gli account di fatturazione con il tipo di contratto Enterprise Agreement.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
billingAccountName	path	True	string	ID che identifica in modo univoco un account di fatturazione. Criterio di espressione regolare: ^([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 che identifica in modo univoco un'assegnazione di ruolo. Criterio di espressione regolare: ^[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	Versione dell'API da usare con la richiesta client. La versione corrente è 2024-04-01.

Corpo della richiesta

Nome	Tipo	Descrizione
properties	BillingRoleAssignmentProperties	Proprietà dell'assegnazione di ruolo di fatturazione.
tags	object	Dizionario dei metadati associati alla risorsa. Potrebbe non essere popolato per tutti i tipi di risorse. Lunghezza massima chiave/valore supportata di 256 caratteri. Chiavi/valore non deve essere vuoto né null. Le chiavi non possono contenere <> % & \ ? /

Risposte

Nome	Tipo	Descrizione
200 OK	BillingRoleAssignment	Proprietà dell'assegnazione di ruolo di fatturazione.
201 Created	BillingRoleAssignment	Proprietà dell'assegnazione di ruolo di fatturazione. Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

BillingRoleAssignmentCreateOrUpdateByBillingAccount

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
BillingRoleAssignment	Proprietà dell'assegnazione di ruolo di fatturazione.
BillingRoleAssignmentProperties	Proprietà dell'assegnazione di ruolo di fatturazione.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PrincipalType	Tipo di un'assegnazione di ruolo.
ProvisioningState	Stato di provisioning della risorsa durante un'operazione a esecuzione prolungata.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

BillingRoleAssignment

Proprietà dell'assegnazione di ruolo di fatturazione.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties	BillingRoleAssignmentProperties	Proprietà dell'assegnazione di ruolo di fatturazione.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Dizionario dei metadati associati alla risorsa. Potrebbe non essere popolato per tutti i tipi di risorse. Lunghezza massima chiave/valore supportata di 256 caratteri. Chiavi/valore non deve essere vuoto né null. Le chiavi non possono contenere <> % & \ ? /
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentProperties

Proprietà dell'assegnazione di ruolo di fatturazione.

Nome	Tipo	Descrizione
billingAccountDisplayName	string	Nome dell'account di fatturazione.
billingAccountId	string	ID completo che identifica in modo univoco un account di fatturazione.
billingProfileDisplayName	string	Nome del profilo di fatturazione.
billingProfileId	string	ID completo che identifica in modo univoco un profilo di fatturazione.
billingRequestId	string	ID della richiesta di fatturazione creata per l'assegnazione di ruolo. Questo è applicabile solo alle assegnazioni di ruolo tra tenant o alle assegnazioni di ruolo create tramite la richiesta di fatturazione.
createdByPrincipalId	string	ID oggetto dell'utente che ha creato l'assegnazione di ruolo.
createdByPrincipalPuid	string	PUID principale dell'utente che ha creato l'assegnazione di ruolo.
createdByPrincipalTenantId	string	ID tenant dell'utente che ha creato l'assegnazione di ruolo.
createdByUserEmailAddress	string	Indirizzo di posta elettronica dell'utente che ha creato l'assegnazione di ruolo. Questa opzione è supportata solo per gli account di fatturazione con il tipo di contratto Enterprise Agreement.
createdOn	string	Data di creazione dell'assegnazione di ruolo.
customerDisplayName	string	Nome del cliente.
customerId	string	ID completo che identifica in modo univoco un cliente.
invoiceSectionDisplayName	string	Nome della sezione della fattura.
invoiceSectionId	string	ID completo che identifica in modo univoco una sezione della fattura.
modifiedByPrincipalId	string	PUID principale dell'utente che ha modificato l'assegnazione di ruolo.
modifiedByPrincipalPuid	string	PUID principale dell'utente che ha modificato l'assegnazione di ruolo.
modifiedByPrincipalTenantId	string	ID tenant dell'utente che ha modificato l'assegnazione di ruolo.
modifiedByUserEmailAddress	string	Indirizzo di posta elettronica dell'utente che ha modificato l'assegnazione di ruolo. Questa opzione è supportata solo per gli account di fatturazione con il tipo di contratto Enterprise Agreement.
modifiedOn	string	Data di modifica dell'assegnazione di ruolo.
principalDisplayName	string	Nome visualizzato dell'entità a cui è stato assegnato il ruolo.
principalId	string	ID oggetto dell'utente a cui è stato assegnato il ruolo.
principalPuid	string	PUID principale dell'utente a cui è stato assegnato il ruolo.
principalTenantId	string	ID tenant principale dell'utente a cui è stato assegnato il ruolo.
principalTenantName	string	Nome descrittivo del tenant dell'utente a cui è stato assegnato il ruolo. Si tratta di "Tenant primario" per il tenant primario dell'account di fatturazione.
principalType	PrincipalType	Tipo di un'assegnazione di ruolo.
provisioningState	ProvisioningState	Stato di provisioning della risorsa durante un'operazione a esecuzione prolungata.
roleDefinitionId	string	ID della definizione del ruolo.
scope	string	Ambito in cui è stato assegnato il ruolo.
userAuthenticationType	string	Tipo di autenticazione dell'utente, organizzazione o account del servizio gestito, dell'utente a cui è stato assegnato il ruolo. Questa opzione è supportata solo per gli account di fatturazione con il tipo di contratto Enterprise Agreement.
userEmailAddress	string	Indirizzo di posta elettronica dell'utente a cui è stato assegnato il ruolo. Questa opzione è supportata solo per gli account di fatturazione con il tipo di contratto Enterprise Agreement.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PrincipalType

Tipo di un'assegnazione di ruolo.

Nome	Tipo	Descrizione
DirectoryRole	string
Everyone	string
Group	string
None	string
ServicePrincipal	string
Unknown	string
User	string

ProvisioningState

Stato di provisioning della risorsa durante un'operazione a esecuzione prolungata.

Nome	Tipo	Descrizione
Canceled	string
Failed	string
New	string
Pending	string
Provisioning	string
Succeeded	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.