Billing Role Assignments - Get By Enrollment Account

Referentie

Service:: Billing

API-versie:: 2024-04-01

Hiermee haalt u een roltoewijzing voor de beller op voor een inschrijvingsaccount. De bewerking wordt alleen ondersteund voor factureringsaccounts met het type Enterprise Agreement van het overeenkomsttype.

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

URI-parameters

Name	In	Vereist	Type	Description
billingAccountName	path	True	string	De id waarmee een factureringsrekening uniek wordt geïdentificeerd. Regex-patroon: `^([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	De id waarmee een roltoewijzing uniek wordt geïdentificeerd. Regex-patroon: `^[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	De naam van het inschrijvingsaccount. Regex-patroon: `^[a-zA-Z\d-_]{1,128}$`
api-version	query	True	string	De versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2024-04-01.

Antwoorden

Name	Type	Description
200 OK	BillingRoleAssignment	De eigenschappen van de toewijzing van de factureringsrol.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

BillingRoleAssignmentGetByEnrollmentAccount

Voorbeeldaanvraag

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


/**
 * Samples for BillingRoleAssignments GetByEnrollmentAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentGetByEnrollmentAccount.json
     */
    /**
     * Sample code: BillingRoleAssignmentGetByEnrollmentAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentGetByEnrollmentAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().getByEnrollmentAccountWithResponse("7898901", "225314",
            "9dfd08c2-62a3-4d47-85bd-1cdba1408402", 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_get_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.get_by_enrollment_account(
        billing_account_name="7898901",
        enrollment_account_name="225314",
        billing_role_assignment_name="9dfd08c2-62a3-4d47-85bd-1cdba1408402",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.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/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/billingRoleAssignmentGetByEnrollmentAccount.json
func ExampleRoleAssignmentsClient_GetByEnrollmentAccount() {
	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)
	}
	res, err := clientFactory.NewRoleAssignmentsClient().GetByEnrollmentAccount(ctx, "7898901", "225314", "9dfd08c2-62a3-4d47-85bd-1cdba1408402", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402"),
	// 	Properties: &armbilling.RoleAssignmentProperties{
	// 		CreatedByUserEmailAddress: to.Ptr("test@billtest900006.onmicrosoft.com"),
	// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-19T20:10:50.102Z"); return t}()),
	// 		RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b"),
	// 		Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314"),
	// 		UserAuthenticationType: to.Ptr("Organization"),
	// 		UserEmailAddress: to.Ptr("a_owner@billtest900006.onmicrosoft.com"),
	// 	},
	// }
}

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 Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
 *
 * @summary Gets a role assignment for the caller on a enrollment Account. 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/billingRoleAssignmentGetByEnrollmentAccount.json
 */
async function billingRoleAssignmentGetByEnrollmentAccount() {
  const billingAccountName = "7898901";
  const enrollmentAccountName = "225314";
  const billingRoleAssignmentName = "9dfd08c2-62a3-4d47-85bd-1cdba1408402";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingRoleAssignments.getByEnrollmentAccount(
    billingAccountName,
    enrollmentAccountName,
    billingRoleAssignmentName,
  );
  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/billingRoleAssignmentGetByEnrollmentAccount.json
// this example is just showing the usage of "BillingRoleAssignments_GetByEnrollmentAccount" 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 = "225314";
string billingRoleAssignmentName = "9dfd08c2-62a3-4d47-85bd-1cdba1408402";
ResourceIdentifier billingEnrollmentAccountRoleAssignmentResourceId = BillingEnrollmentAccountRoleAssignmentResource.CreateResourceIdentifier(billingAccountName, enrollmentAccountName, billingRoleAssignmentName);
BillingEnrollmentAccountRoleAssignmentResource billingEnrollmentAccountRoleAssignment = client.GetBillingEnrollmentAccountRoleAssignmentResource(billingEnrollmentAccountRoleAssignmentResourceId);

// invoke the operation
BillingEnrollmentAccountRoleAssignmentResource result = await billingEnrollmentAccountRoleAssignment.GetAsync();

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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402",
  "properties": {
    "createdOn": "2023-10-19T20:10:50.1028398Z",
    "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com",
    "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b",
    "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314",
    "userAuthenticationType": "Organization",
    "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com"
  },
  "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
}

Definities

Name	Description
BillingRoleAssignment	De eigenschappen van de toewijzing van de factureringsrol.
BillingRoleAssignmentProperties	De eigenschappen van de toewijzing van de factureringsrol.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
PrincipalType	Het type roltoewijzing.
ProvisioningState	De inrichtingsstatus van de resource tijdens een langdurige bewerking.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

BillingRoleAssignment

De eigenschappen van de toewijzing van de factureringsrol.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	BillingRoleAssignmentProperties	De eigenschappen van de toewijzing van de factureringsrol.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Woordenlijst met metagegevens die zijn gekoppeld aan de resource. Deze kan niet worden ingevuld voor alle resourcetypen. Maximale lengte van sleutel/waarde die wordt ondersteund door 256 tekens. Sleutels/waarde mogen geen lege waarde of null zijn. Sleutels kunnen geen <> % & \ bevatten? /
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BillingRoleAssignmentProperties

De eigenschappen van de toewijzing van de factureringsrol.

Name	Type	Description
billingAccountDisplayName	string	De naam van de factureringsrekening.
billingAccountId	string	De volledig gekwalificeerde id waarmee een factureringsrekening uniek wordt geïdentificeerd.
billingProfileDisplayName	string	De naam van het factureringsprofiel.
billingProfileId	string	De volledig gekwalificeerde id waarmee een factureringsprofiel uniek wordt geïdentificeerd.
billingRequestId	string	De id van de factureringsaanvraag die is gemaakt voor de roltoewijzing. Dit is alleen van toepassing op roltoewijzingen voor meerdere tenants of roltoewijzingen die zijn gemaakt via de factureringsaanvraag.
createdByPrincipalId	string	De object-id van de gebruiker die de roltoewijzing heeft gemaakt.
createdByPrincipalPuid	string	De principal PUID van de gebruiker die de roltoewijzing heeft gemaakt.
createdByPrincipalTenantId	string	De tenant-id van de gebruiker die de roltoewijzing heeft gemaakt.
createdByUserEmailAddress	string	Het e-mailadres van de gebruiker die de roltoewijzing heeft gemaakt. Dit wordt alleen ondersteund voor factureringsaccounts met enterprise agreement-type.
createdOn	string	De datum waarop de roltoewijzing is gemaakt.
customerDisplayName	string	De naam van de klant.
customerId	string	De volledig gekwalificeerde id waarmee een klant uniek wordt geïdentificeerd.
invoiceSectionDisplayName	string	De naam van de factuursectie.
invoiceSectionId	string	De volledig gekwalificeerde id waarmee een factuursectie uniek wordt geïdentificeerd.
modifiedByPrincipalId	string	De principal PUID van de gebruiker die de roltoewijzing heeft gewijzigd.
modifiedByPrincipalPuid	string	De principal PUID van de gebruiker die de roltoewijzing heeft gewijzigd.
modifiedByPrincipalTenantId	string	De tenant-id van de gebruiker die de roltoewijzing heeft gewijzigd.
modifiedByUserEmailAddress	string	Het e-mailadres van de gebruiker die de roltoewijzing heeft gewijzigd. Dit wordt alleen ondersteund voor factureringsaccounts met enterprise agreement-type.
modifiedOn	string	De datum waarop de roltoewijzing is gewijzigd.
principalDisplayName	string	De weergavenaam van de principal aan wie de rol is toegewezen.
principalId	string	De object-id van de gebruiker aan wie de rol is toegewezen.
principalPuid	string	De principal PUID van de gebruiker aan wie de rol is toegewezen.
principalTenantId	string	De principal-tenant-id van de gebruiker aan wie de rol is toegewezen.
principalTenantName	string	De beschrijvende naam van de tenant van de gebruiker aan wie de rol is toegewezen. Dit is 'Primaire tenant' voor de primaire tenant van de factureringsrekening.
principalType	PrincipalType	Het type roltoewijzing.
provisioningState	ProvisioningState	De inrichtingsstatus van de resource tijdens een langdurige bewerking.
roleDefinitionId	string	De id van de roldefinitie.
scope	string	Het bereik waaraan de rol is toegewezen.
userAuthenticationType	string	Het verificatietype van de gebruiker, organisatie of MSA, van de gebruiker aan wie de rol is toegewezen. Dit wordt alleen ondersteund voor factureringsaccounts met enterprise agreement-type.
userEmailAddress	string	Het e-mailadres van de gebruiker aan wie de rol is toegewezen. Dit wordt alleen ondersteund voor factureringsaccounts met enterprise agreement-type.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

PrincipalType

Het type roltoewijzing.

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

ProvisioningState

De inrichtingsstatus van de resource tijdens een langdurige bewerking.

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

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.