Billing Role Assignments - List By Billing Profile

Service:

Billing

API Version:

2020-05-01

Listet die Rollenzuweisungen für den Aufrufer in einem Abrechnungsprofil auf. Der Vorgang wird für Abrechnungskonten mit dem Vertragstyp Microsoft-Kundenvereinbarung unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileName	path	True	string	Die ID, die ein Abrechnungsprofil eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 01.05.2020.

Antworten

Name	Typ	Beschreibung
200 OK	BillingRoleAssignmentListResult	OK. Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

BillingProfileRoleAssignmentList

Sample Request

HTTP

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

Java

/** Samples for BillingRoleAssignments ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json
     */
    /**
     * Sample code: BillingProfileRoleAssignmentList.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingProfileRoleAssignmentList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingRoleAssignments()
            .listByBillingProfile("{billingAccountName}", "{billingProfileName}", 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_profile_role_assignment_list.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="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.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("{billingAccountName}", "{billingProfileName}", 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/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1"),
		// 				CreatedByPrincipalTenantID: to.Ptr("7ca289b9-c32d-4f01-8566-7ff93261d76f"),
		// 				CreatedOn: to.Ptr("2018-06-21T21:34:12.2363515+00:00"),
		// 				PrincipalID: to.Ptr("6fd330f6-7d26-4aff-b9cf-7bd699f965b9"),
		// 				PrincipalTenantID: to.Ptr("10000000-aaaa-bbbb-cccc-2d7cd011db47"),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbilling.RoleAssignmentProperties{
		// 				CreatedByPrincipalID: to.Ptr("10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1"),
		// 				CreatedByPrincipalTenantID: to.Ptr("7ca289b9-c32d-4f01-8566-7ff93261d76f"),
		// 				CreatedOn: to.Ptr("2018-06-21T21:58:19.9073876+00:00"),
		// 				PrincipalID: to.Ptr("b1839933-b3ac-42ca-8112-d29c43f3ab47"),
		// 				PrincipalTenantID: to.Ptr("10000000-aaaa-bbbb-cccc-2d7cd011db47"),
		// 				RoleDefinitionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"),
		// 				Scope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 			},
		// 	}},
		// }
	}
}

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 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 Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json
 */
async function billingProfileRoleAssignmentList() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingRoleAssignments.listByBillingProfile(
    billingAccountName,
    billingProfileName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

billingProfileRoleAssignmentList().catch(console.error);

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
      "properties": {
        "createdOn": "2018-06-21T21:34:12.2363515+00:00",
        "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
        "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
        "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9",
        "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
      "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000",
      "properties": {
        "createdOn": "2018-06-21T21:58:19.9073876+00:00",
        "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f",
        "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1",
        "principalId": "b1839933-b3ac-42ca-8112-d29c43f3ab47",
        "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47",
        "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments"
    }
  ]
}

Definitionen

Name	Beschreibung
BillingRoleAssignment	Die Rollenzuweisung
BillingRoleAssignmentListResult	Die Liste der Rollenzuweisungen.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
ErrorSubDetails

BillingRoleAssignment

Die Rollenzuweisung

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Name der Ressource.
properties.createdByPrincipalId	string	Die Prinzipal-ID des Benutzers, der die Rollenzuweisung erstellt hat.
properties.createdByPrincipalTenantId	string	Die Mandanten-ID des Benutzers, der die Rollenzuweisung erstellt hat.
properties.createdByUserEmailAddress	string	Die E-Mail-Adresse des Benutzers, der die Rollenzuweisung erstellt hat.
properties.createdOn	string	Das Datum, an dem die Rollenzuweisung erstellt wurde.
properties.principalId	string	Die Prinzipal-ID des Benutzers, dem die Rolle zugewiesen wurde.
properties.principalTenantId	string	Die Prinzipalmandanten-ID des Benutzers, dem die Rolle zugewiesen wurde.
properties.roleDefinitionId	string	Die ID der Rollendefinition.
properties.scope	string	Der Bereich, in dem die Rolle zugewiesen wurde.
properties.userAuthenticationType	string	Der Authentifizierungstyp.
properties.userEmailAddress	string	Die E-Mail-Adresse des Benutzers.
type	string	Der Ressourcentyp.

BillingRoleAssignmentListResult

Die Liste der Rollenzuweisungen.

Name	Typ	Beschreibung
nextLink	string	Der Link (URL) zur nächsten Ergebnisseite.
value	BillingRoleAssignment[]	Die Liste der Rollenzuweisungen.

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorSubDetails[]	Die Unterdetails des Fehlers.
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des jeweiligen Fehlers.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ErrorSubDetails

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des jeweiligen Fehlers.