Share via


Billing Role Definition - List By Billing Account

Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

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

URI Parameters

Name In Required Type Description
billingAccountName
path True

string

pattern: ^([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})?)$

The ID that uniquely identifies a billing account.

api-version
query True

string

The version of the API to be used with the client request. The current version is 2024-04-01.

Responses

Name Type Description
200 OK

BillingRoleDefinitionListResult

The list of role definitions.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

BillingRoleDefinitionListByBillingAccount

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions?api-version=2024-04-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000",
      "name": "50000000-aaaa-bbbb-cccc-100000000000",
      "properties": {
        "permissions": [
          {
            "actions": [
              "50000000-aaaa-bbbb-cccc-200000000000",
              "50000000-aaaa-bbbb-cccc-200000000001",
              "50000000-aaaa-bbbb-cccc-200000000002",
              "50000000-aaaa-bbbb-cccc-200000000003",
              "50000000-aaaa-bbbb-cccc-200000000004",
              "50000000-aaaa-bbbb-cccc-200000000006",
              "50000000-aaaa-bbbb-cccc-200000000007",
              "50000000-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",
              "50000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000000",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000009",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000017",
              "30000000-aaaa-bbbb-cccc-200000000018",
              "40000000-aaaa-bbbb-cccc-200000000000",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000008",
              "40000000-aaaa-bbbb-cccc-200000000012",
              "40000000-aaaa-bbbb-cccc-200000000013",
              "40000000-aaaa-bbbb-cccc-200000000004",
              "40000000-aaaa-bbbb-cccc-200000000001",
              "40000000-aaaa-bbbb-cccc-200000000005",
              "40000000-aaaa-bbbb-cccc-200000000002",
              "40000000-aaaa-bbbb-cccc-200000000003",
              "40000000-aaaa-bbbb-cccc-200000000011",
              "30000000-aaaa-bbbb-cccc-200000000013",
              "30000000-aaaa-bbbb-cccc-200000000011",
              "30000000-aaaa-bbbb-cccc-200000000006",
              "30000000-aaaa-bbbb-cccc-200000000003",
              "30000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000012",
              "30000000-aaaa-bbbb-cccc-200000000008",
              "30000000-aaaa-bbbb-cccc-200000000016"
            ]
          }
        ],
        "roleName": "Billing account owner"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001",
      "name": "50000000-aaaa-bbbb-cccc-100000000001",
      "properties": {
        "description": "The Contributor role gives the user all permissions except access management on the organization.",
        "permissions": [
          {
            "actions": [
              "50000000-aaaa-bbbb-cccc-200000000001",
              "50000000-aaaa-bbbb-cccc-200000000002",
              "50000000-aaaa-bbbb-cccc-200000000003",
              "50000000-aaaa-bbbb-cccc-200000000004",
              "50000000-aaaa-bbbb-cccc-200000000006",
              "50000000-aaaa-bbbb-cccc-200000000007",
              "50000000-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",
              "50000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000009",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000017",
              "30000000-aaaa-bbbb-cccc-200000000018",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000008",
              "40000000-aaaa-bbbb-cccc-200000000012",
              "40000000-aaaa-bbbb-cccc-200000000013",
              "40000000-aaaa-bbbb-cccc-200000000004",
              "40000000-aaaa-bbbb-cccc-200000000001",
              "40000000-aaaa-bbbb-cccc-200000000005",
              "40000000-aaaa-bbbb-cccc-200000000002",
              "40000000-aaaa-bbbb-cccc-200000000003",
              "40000000-aaaa-bbbb-cccc-200000000011",
              "30000000-aaaa-bbbb-cccc-200000000013",
              "30000000-aaaa-bbbb-cccc-200000000011",
              "30000000-aaaa-bbbb-cccc-200000000006",
              "30000000-aaaa-bbbb-cccc-200000000003",
              "30000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000012",
              "30000000-aaaa-bbbb-cccc-200000000008",
              "30000000-aaaa-bbbb-cccc-200000000016"
            ]
          }
        ],
        "roleName": "Billing account contributor"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002",
      "name": "50000000-aaaa-bbbb-cccc-100000000002",
      "properties": {
        "description": "The Reader role gives the user read permissions to an organization.",
        "permissions": [
          {
            "actions": [
              "50000000-aaaa-bbbb-cccc-200000000001",
              "50000000-aaaa-bbbb-cccc-200000000006",
              "50000000-aaaa-bbbb-cccc-200000000007",
              "10000000-aaaa-bbbb-cccc-200000000003",
              "50000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000017",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000008",
              "40000000-aaaa-bbbb-cccc-200000000012"
            ]
          }
        ],
        "roleName": "Billing account reader"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002",
      "name": "50000000-aaaa-bbbb-cccc-100000000002",
      "properties": {
        "description": "The Reader role gives the user read permissions to an organization.",
        "permissions": [
          {
            "actions": [
              "50000000-aaaa-bbbb-cccc-200000000001",
              "50000000-aaaa-bbbb-cccc-200000000006",
              "50000000-aaaa-bbbb-cccc-200000000007",
              "10000000-aaaa-bbbb-cccc-200000000003",
              "50000000-aaaa-bbbb-cccc-200000000005",
              "30000000-aaaa-bbbb-cccc-200000000001",
              "30000000-aaaa-bbbb-cccc-200000000004",
              "30000000-aaaa-bbbb-cccc-200000000007",
              "30000000-aaaa-bbbb-cccc-200000000010",
              "30000000-aaaa-bbbb-cccc-200000000015",
              "30000000-aaaa-bbbb-cccc-200000000017",
              "40000000-aaaa-bbbb-cccc-200000000006",
              "40000000-aaaa-bbbb-cccc-200000000007",
              "40000000-aaaa-bbbb-cccc-200000000008",
              "40000000-aaaa-bbbb-cccc-200000000012"
            ]
          }
        ],
        "roleName": "Billing account reader"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000003",
      "name": "50000000-aaaa-bbbb-cccc-100000000003",
      "properties": {
        "description": "The Purchaser role gives the user permissions to make purchases by creating new Projects and Billing Groups in an organization.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000006",
              "10000000-aaaa-bbbb-cccc-200000000007",
              "50000000-aaaa-bbbb-cccc-200000000001",
              "50000000-aaaa-bbbb-cccc-200000000006"
            ]
          }
        ],
        "roleName": "Basic Purchaser"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    }
  ]
}

Definitions

Name Description
BillingPermission

The set of allowed action and not allowed actions a caller has on a resource.

BillingRoleDefinition

The properties of a role definition.

BillingRoleDefinitionListResult

A container for a list of resources

BillingRoleDefinitionProperties

The properties of a role definition.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

systemData

Metadata pertaining to creation and last modification of the resource.

BillingPermission

The set of allowed action and not allowed actions a caller has on a resource.

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.

BillingRoleDefinition

The properties of a role definition.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

The name of the resource

properties

BillingRoleDefinitionProperties

The properties of a role definition.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BillingRoleDefinitionListResult

A container for a list of resources

Name Type Description
nextLink

string

The link (url) to the next page of results.

value

BillingRoleDefinition[]

The list of resources.

BillingRoleDefinitionProperties

The properties of a role definition.

Name Type Description
description

string

The role description.

permissions

BillingPermission[]

The billingPermissions the role has.

roleName

string

minLength: 1

The name of the role.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.