Billing Role Definitions - Get By Billing Account

Reference

Service:: Billing

API Version:: 2020-05-01

Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

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

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
billingRoleDefinitionName	path	True	string	The ID that uniquely identifies a role definition.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2020-05-01.

Responses

Name	Type	Description
200 OK	BillingRoleDefinition	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

BillingAccountRoleDefinition

Sample Request

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

/** Samples for BillingRoleDefinitions GetByBillingAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json
     */
    /**
     * Sample code: BillingAccountRoleDefinition.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingAccountRoleDefinition(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingRoleDefinitions()
            .getByBillingAccountWithResponse(
                "{billingAccountName}", "{billingRoleDefinitionName}", 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_account_role_definition.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_definitions.get_by_billing_account(
        billing_account_name="{billingAccountName}",
        billing_role_definition_name="{billingRoleDefinitionName}",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json
func ExampleRoleDefinitionsClient_GetByBillingAccount() {
	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.NewRoleDefinitionsClient().GetByBillingAccount(ctx, "{billingAccountName}", "{billingRoleDefinitionName}", 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.RoleDefinition = armbilling.RoleDefinition{
	// 	Name: to.Ptr("{billingRoleDefinitionName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingRoleDefinitions"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}"),
	// 	Properties: &armbilling.RoleDefinitionProperties{
	// 		Description: to.Ptr("The Owner role gives the user all permissions including access management rights to the billing account."),
	// 		Permissions: []*armbilling.PermissionsProperties{
	// 			{
	// 				Actions: []*string{
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000000"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000008"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000001"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000002"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000003"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000006"),
	// 					to.Ptr("10000000-aaaa-bbbb-cccc-200000000007"),
	// 					to.Ptr("20000000-aaaa-bbbb-cccc-200000000000"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000000"),
	// 					to.Ptr("40000000-aaaa-bbbb-cccc-200000000000"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000009"),
	// 					to.Ptr("20000000-aaaa-bbbb-cccc-200000000002"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000015"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000004"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000007"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000001"),
	// 					to.Ptr("30000000-aaaa-bbbb-cccc-200000000010"),
	// 					to.Ptr("40000000-aaaa-bbbb-cccc-200000000007"),
	// 					to.Ptr("40000000-aaaa-bbbb-cccc-200000000006"),
	// 					to.Ptr("40000000-aaaa-bbbb-cccc-200000000008")},
	// 					NotActions: []*string{
	// 					},
	// 			}},
	// 			RoleName: to.Ptr("Billing acount owner"),
	// 		},
	// 	}
}

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 the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Gets the definition for a role 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/2020-05-01/examples/BillingAccountRoleDefinition.json
 */
async function billingAccountRoleDefinition() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingRoleDefinitionName = "{billingRoleDefinitionName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.billingRoleDefinitions.getByBillingAccount(
    billingAccountName,
    billingRoleDefinitionName
  );
  console.log(result);
}

billingAccountRoleDefinition().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

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}",
  "name": "{billingRoleDefinitionName}",
  "properties": {
    "description": "The Owner role gives the user all permissions including access management rights to the billing account.",
    "permissions": [
      {
        "actions": [
          "10000000-aaaa-bbbb-cccc-200000000000",
          "10000000-aaaa-bbbb-cccc-200000000008",
          "10000000-aaaa-bbbb-cccc-200000000001",
          "10000000-aaaa-bbbb-cccc-200000000002",
          "10000000-aaaa-bbbb-cccc-200000000003",
          "10000000-aaaa-bbbb-cccc-200000000006",
          "10000000-aaaa-bbbb-cccc-200000000007",
          "20000000-aaaa-bbbb-cccc-200000000000",
          "30000000-aaaa-bbbb-cccc-200000000000",
          "40000000-aaaa-bbbb-cccc-200000000000",
          "30000000-aaaa-bbbb-cccc-200000000009",
          "20000000-aaaa-bbbb-cccc-200000000002",
          "30000000-aaaa-bbbb-cccc-200000000015",
          "30000000-aaaa-bbbb-cccc-200000000004",
          "30000000-aaaa-bbbb-cccc-200000000007",
          "30000000-aaaa-bbbb-cccc-200000000001",
          "30000000-aaaa-bbbb-cccc-200000000010",
          "40000000-aaaa-bbbb-cccc-200000000007",
          "40000000-aaaa-bbbb-cccc-200000000006",
          "40000000-aaaa-bbbb-cccc-200000000008"
        ],
        "notActions": []
      }
    ],
    "roleName": "Billing acount owner"
  },
  "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
}

Definitions

Name	Description
BillingPermissionsProperties	The set of allowed action and not allowed actions a caller has on a billing account
BillingRoleDefinition	The properties of a role definition.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails

BillingPermissionsProperties

The set of allowed action and not allowed actions a caller has on a billing account

Name	Type	Description
actions	string[]	The set of actions that the caller is allowed to perform.
notActions	string[]	The set of actions that the caller is not allowed to perform.