Billing Role Assignments - List By Billing Profile

Tjänst:

Billing

API-version:

2024-04-01

Visar en lista över rolltilldelningar för anroparen i en faktureringsprofil. Åtgärden stöds för faktureringskonton med avtalstypen Microsoft-partneravtal eller Microsoft-kundavtal.

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

Med valfria parametrar:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments?api-version=2024-04-01&filter={filter}&top={top}&skip={skip}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountName	path	True	string	Det ID som unikt identifierar ett faktureringskonto. Reguljärt uttrycksmönster: ^([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})?)$
billingProfileName	path	True	string	Det ID som unikt identifierar en faktureringsprofil. Reguljärt uttrycksmönster: ^[a-zA-Z\d-_]{1,128}$
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2024-04-01.
filter	query		string	Med alternativet filterfråga kan klienter filtrera en samling resurser som adresseras av en begärande-URL.
skip	query		integer int64	Alternativet Hoppa över fråga begär antalet objekt i den efterfrågade samlingen som ska hoppas över och inte inkluderas i resultatet.
top	query		integer int64	Det översta frågealternativet begär att antalet objekt i den efterfrågade samlingen inkluderas i resultatet. Det maximala värdet som stöds för top är 50.

Svar

Name	Typ	Description
200 OK	BillingRoleAssignmentListResult	Listan över tilldelningar av faktureringsroller.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

BillingRoleAssignmentListByBillingProfile

Exempelbegäran

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments?api-version=2024-04-01

Java

/**
 * Samples for BillingRoleAssignments ListByBillingProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRoleAssignmentListByBillingProfile.json
     */
    /**
     * Sample code: BillingRoleAssignmentListByBillingProfile.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingRoleAssignmentListByBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRoleAssignments().listByBillingProfile(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "xxxx-xxxx-xxx-xxx",
            null, null, null, 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_list_by_billing_profile.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.list_by_billing_profile(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.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/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/billingRoleAssignmentListByBillingProfile.json
func ExampleRoleAssignmentsClient_NewListByBillingProfilePager() {
	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)
	}
	pager := clientFactory.NewRoleAssignmentsClient().NewListByBillingProfilePager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", "xxxx-xxxx-xxx-xxx", &armbilling.RoleAssignmentsClientListByBillingProfileOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RoleAssignmentListResult = armbilling.RoleAssignmentListResult{
		// 	Value: []*armbilling.RoleAssignment{
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("00000000-0000-0000-0000-000000000001"),
		// 				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/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("00000000-0000-0000-0000-000000000001"),
		// 				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/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Lists the role assignments for the caller on a billing profile. 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/billingRoleAssignmentListByBillingProfile.json
 */
async function billingRoleAssignmentListByBillingProfile() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingRoleAssignments.listByBillingProfile(
    billingAccountName,
    billingProfileName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json
// this example is just showing the usage of "BillingRoleAssignments_ListByBillingProfile" 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 BillingProfileResource created on azure
// for more information of creating BillingProfileResource, please refer to the document of BillingProfileResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
ResourceIdentifier billingProfileResourceId = BillingProfileResource.CreateResourceIdentifier(billingAccountName, billingProfileName);
BillingProfileResource billingProfile = client.GetBillingProfileResource(billingProfileResourceId);

// get the collection of this BillingProfileRoleAssignmentResource
BillingProfileRoleAssignmentCollection collection = billingProfile.GetBillingProfileRoleAssignments();

// invoke the operation and iterate over the result
await foreach (BillingProfileRoleAssignmentResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "00000000-0000-0000-0000-000000000001",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47",
      "properties": {
        "createdOn": "2023-10-19T20:10:50.1028398Z",
        "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb",
        "createdByPrincipalId": "00000000-0000-0000-0000-000000000001",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001",
        "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    }
  ]
}

Definitioner

Name	Description
BillingRoleAssignment	Egenskaperna för tilldelningen av faktureringsrollen.
BillingRoleAssignmentListResult	En container för en lista över resurser
BillingRoleAssignmentProperties	Egenskaperna för tilldelningen av faktureringsrollen.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
PrincipalType	Typ av rolltilldelning.
ProvisioningState	Resursens etableringstillstånd under en långvarig åtgärd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

BillingRoleAssignment

Egenskaperna för tilldelningen av faktureringsrollen.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	BillingRoleAssignmentProperties	Egenskaperna för tilldelningen av faktureringsrollen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Ordlista med metadata som är associerade med resursen. Den kanske inte fylls i för alla resurstyper. Maximal nyckel/värdelängd som stöds på 256 tecken. Nycklar/värde får inte vara tomt eller null. Nycklar kan inte innehålla <> % & \ ? /
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BillingRoleAssignmentListResult

En container för en lista över resurser

Name	Typ	Description
nextLink	string	Länken (url) till nästa resultatsida.
value	BillingRoleAssignment[]	Listan över resurser.

BillingRoleAssignmentProperties

Egenskaperna för tilldelningen av faktureringsrollen.

Name	Typ	Description
billingAccountDisplayName	string	Namnet på faktureringskontot.
billingAccountId	string	Det fullständigt kvalificerade ID som unikt identifierar ett faktureringskonto.
billingProfileDisplayName	string	Namnet på faktureringsprofilen.
billingProfileId	string	Det fullständigt kvalificerade ID som unikt identifierar en faktureringsprofil.
billingRequestId	string	ID för faktureringsbegäran som skapades för rolltilldelningen. Detta gäller endast för rolltilldelningar mellan klientorganisationer eller rolltilldelningar som skapats via faktureringsbegäran.
createdByPrincipalId	string	Objekt-ID för användaren som skapade rolltilldelningen.
createdByPrincipalPuid	string	Huvud-PUID för den användare som skapade rolltilldelningen.
createdByPrincipalTenantId	string	Klientorganisations-ID:t för den användare som skapade rolltilldelningen.
createdByUserEmailAddress	string	E-postadressen till den användare som skapade rolltilldelningen. Detta stöds endast för faktureringskonton med avtalstyp Enterprise-avtal.
createdOn	string	Det datum då rolltilldelningen skapades.
customerDisplayName	string	Kundens namn.
customerId	string	Det fullständigt kvalificerade ID som unikt identifierar en kund.
invoiceSectionDisplayName	string	Namnet på fakturaavsnittet.
invoiceSectionId	string	Det fullständigt kvalificerade ID som unikt identifierar ett fakturaavsnitt.
modifiedByPrincipalId	string	Huvud-PUID för den användare som ändrade rolltilldelningen.
modifiedByPrincipalPuid	string	Huvud-PUID för den användare som ändrade rolltilldelningen.
modifiedByPrincipalTenantId	string	Klientorganisations-ID:t för den användare som ändrade rolltilldelningen.
modifiedByUserEmailAddress	string	E-postadressen till den användare som ändrade rolltilldelningen. Detta stöds endast för faktureringskonton med avtalstyp Enterprise-avtal.
modifiedOn	string	Datumet då rolltilldelningen ändrades.
principalDisplayName	string	Visningsnamnet för det huvudnamn som rollen tilldelades till.
principalId	string	Objekt-ID för den användare som rollen tilldelades till.
principalPuid	string	Huvud-PUID för den användare som rollen tilldelades till.
principalTenantId	string	Huvudklient-ID:t för den användare som rollen tilldelades till.
principalTenantName	string	Det egna namnet på klientorganisationen för den användare som rollen tilldelades till. Detta blir "Primär klientorganisation" för den primära klientorganisationen för faktureringskontot.
principalType	PrincipalType	Typ av rolltilldelning.
provisioningState	ProvisioningState	Resursens etableringstillstånd under en långvarig åtgärd.
roleDefinitionId	string	ID för rolldefinitionen.
scope	string	Det omfång som rollen tilldelades till.
userAuthenticationType	string	Autentiseringstypen för användaren, oavsett om det är Organisation eller MSA, för den användare som rollen tilldelades till. Detta stöds endast för faktureringskonton med avtalstyp Enterprise-avtal.
userEmailAddress	string	E-postadressen till den användare som rollen tilldelades till. Detta stöds endast för faktureringskonton med avtalstyp Enterprise-avtal.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

PrincipalType

Typ av rolltilldelning.

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

ProvisioningState

Resursens etableringstillstånd under en långvarig åtgärd.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.