Billing Role Definitions - 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=2019-10-01-preview

URI Parameters

Name In Required Type Description
billingAccountName
path True
  • string

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 2019-10-01-preview.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

Other Status Codes

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

BillingAccountEaRoleDefinitionsList
BillingAccountRoleDefinitionsList

BillingAccountEaRoleDefinitionsList

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db",
      "name": "9f1983cb-2574-400c-87e9-34cf8e2280db",
      "properties": {
        "description": "The enrollment administrator role gives the user all permissions including access management rights to an Enrollment and its departments and accounts.",
        "permissions": [
          {
            "actions": [
              "Microsoft.Billing/billingAccounts/read",
              "Microsoft.Billing/billingAccounts/write",
              "Microsoft.Billing/billingAccounts/action",
              "Microsoft.Billing/billingAccounts/enrollmentPolicies/read",
              "Microsoft.Billing/billingAccounts/enrollmentPolicies/write",
              "Microsoft.Billing/billingAccounts/enrollmentPolicies/action",
              "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read",
              "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/write",
              "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/action",
              "Microsoft.Billing/billingAccounts/departments/read",
              "Microsoft.Billing/billingAccounts/departments/write",
              "Microsoft.Billing/billingAccounts/departments/action",
              "Microsoft.Billing/billingAccounts/departments/delete",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/read",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/write",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/action",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action"
            ]
          }
        ],
        "roleName": "Enrollment administrator"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/24f8edb6-1668-4659-b5e2-40bb5f3a7d7e",
      "name": "24f8edb6-1668-4659-b5e2-40bb5f3a7d7e",
      "properties": {
        "description": "The enrollment reader role gives the user read-only permissions to an Enrollment and its departments and accounts.",
        "permissions": [
          {
            "actions": [
              "Microsoft.Billing/billingAccounts/read",
              "Microsoft.Billing/billingAccounts/enrollmentPolicies/read",
              "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read",
              "Microsoft.Billing/billingAccounts/departments/read",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/read",
              "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read"
            ]
          }
        ],
        "roleName": "Enrollment reader"
      },
      "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions"
    }
  ]
}

BillingAccountRoleDefinitionsList

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000",
      "name": "10000000-aaaa-bbbb-cccc-100000000000",
      "properties": {
        "description": "The Owner role gives the user all permissions including access management rights to the Commerce Root.",
        "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": "commerce_root_owner"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001",
      "name": "10000000-aaaa-bbbb-cccc-100000000001",
      "properties": {
        "description": "The Contributor role give the user all permissions except access management rights to the Commerce Root.",
        "permissions": [
          {
            "actions": [
              "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",
              "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": "commerce_root_contributor"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000002",
      "name": "10000000-aaaa-bbbb-cccc-100000000002",
      "properties": {
        "description": "The Reader role gives the user read only access to the Commerce Root.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000008",
              "10000000-aaaa-bbbb-cccc-200000000003",
              "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": "commerce_root_reader"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000003",
      "name": "10000000-aaaa-bbbb-cccc-100000000003",
      "properties": {
        "description": "The Signatory role can sign agreements on behalf of the customer.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000002",
              "10000000-aaaa-bbbb-cccc-200000000003"
            ],
            "notActions": []
          }
        ],
        "roleName": "signatory"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000004",
      "name": "10000000-aaaa-bbbb-cccc-100000000004",
      "properties": {
        "description": "The Basic Purchaser role gives the user the ability to make purchases by creating new Projects and Billing Groups.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000006",
              "10000000-aaaa-bbbb-cccc-200000000007"
            ],
            "notActions": []
          }
        ],
        "roleName": "commerce_root_basic_purchaser"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000005",
      "name": "10000000-aaaa-bbbb-cccc-100000000005",
      "properties": {
        "description": "The Project Creator role gives the user the ability to create new Projects.",
        "permissions": [
          {
            "actions": [
              "10000000-aaaa-bbbb-cccc-200000000006"
            ],
            "notActions": []
          }
        ],
        "roleName": "project_creator"
      },
      "type": "Microsoft.Billing/billingRoleDefinitions"
    }
  ]
}

Definitions

BillingPermissionsProperties

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

BillingRoleDefinition

The properties of a role definition.

BillingRoleDefinitionListResult

The list of role definitions.

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.

BillingRoleDefinition

The properties of a role definition.

Name Type Description
id
  • string

Resource Id.

name
  • string

Resource name.

properties.description
  • string

The role description

properties.permissions

The billingPermissions the role has

properties.roleName
  • string

The name of the role

type
  • string

Resource type.

BillingRoleDefinitionListResult

The list of role definitions.

Name Type Description
nextLink
  • string

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

value

The role definitions.

ErrorDetails

The details of the error.

Name Type Description
code
  • string

Error code.

details

The sub details of the error.

message
  • string

Error message indicating why the operation failed.

target
  • string

The target of the particular error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
error

The details of the error.

ErrorSubDetails

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

target
  • string

The target of the particular error.