Billing Role Assignments - List By Enrollment Account

  • Reference
Service:
Billing
API Version:
2024-04-01

Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.

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

URI Parameters

Name In Required Type Description
billingAccountName
 path True

string

The ID that uniquely identifies a billing account.

Regex 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})?)$
enrollmentAccountName
 path True

string

The name of the enrollment account.

Regex pattern: ^[a-zA-Z\d-_]{1,128}$
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

BillingRoleAssignmentListResult

The list of the billing role assignments.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

BillingRoleAssignmentListByEnrollmentAccount

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments?api-version=2024-04-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/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/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000",
        "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/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/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001",
        "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456",
        "principalType": "User"
      },
      "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments"
    }
  ]
}

Definitions

Name Description
BillingRoleAssignment

The properties of the billing role assignment.
BillingRoleAssignmentListResult

A container for a list of resources
BillingRoleAssignmentProperties

The properties of the billing role assignment.
createdByType

The type of identity that created the resource.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
PrincipalType

The type of a role Assignment.
ProvisioningState

The provisioning state of the resource during a long-running operation.
systemData

Metadata pertaining to creation and last modification of the resource.

BillingRoleAssignment

The properties of the billing role assignment.

Name Type Description
id

string

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

BillingRoleAssignmentProperties

The properties of the billing role assignment.
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"

BillingRoleAssignmentListResult

A container for a list of resources

Name Type Description
nextLink

string

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

BillingRoleAssignment[]

The list of resources.

BillingRoleAssignmentProperties

The properties of the billing role assignment.

Name Type Description
billingAccountDisplayName

string

The name of the billing account.
billingAccountId

string

The fully qualified ID that uniquely identifies a billing account.
billingProfileDisplayName

string

The name of the billing profile.
billingProfileId

string

The fully qualified ID that uniquely identifies a billing profile.
billingRequestId

string

The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request.
createdByPrincipalId

string

The object ID of the user who created the role assignment.
createdByPrincipalPuid

string

The principal PUID of the user who created the role assignment.
createdByPrincipalTenantId

string

The tenant Id of the user who created the role assignment.
createdByUserEmailAddress

string

The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.
createdOn

string

The date the role assignment was created.
customerDisplayName

string

The name of the customer.
customerId

string

The fully qualified ID that uniquely identifies a customer.
invoiceSectionDisplayName

string

The name of the invoice section.
invoiceSectionId

string

The fully qualified ID that uniquely identifies an invoice section.
modifiedByPrincipalId

string

The principal PUID of the user who modified the role assignment.
modifiedByPrincipalPuid

string

The principal PUID of the user who modified the role assignment.
modifiedByPrincipalTenantId

string

The tenant Id of the user who modified the role assignment.
modifiedByUserEmailAddress

string

The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.
modifiedOn

string

The date the role assignment was modified.
principalDisplayName

string

The display name of the principal to whom the role was assigned.
principalId

string

The object id of the user to whom the role was assigned.
principalPuid

string

The principal PUID of the user to whom the role was assigned.
principalTenantId

string

The principal tenant id of the user to whom the role was assigned.
principalTenantName

string

The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account.
principalType

PrincipalType

The type of a role Assignment.
provisioningState

ProvisioningState

The provisioning state of the resource during a long-running operation.
roleDefinitionId

string

The ID of the role definition.
scope

string

The scope at which the role was assigned.
userAuthenticationType

string

The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.
userEmailAddress

string

The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

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.

PrincipalType

The type of a role Assignment.

Name Type Description
DirectoryRole

string

Everyone

string

Group

string

None

string

ServicePrincipal

string

Unknown

string

User

string

ProvisioningState

The provisioning state of the resource during a long-running operation.

Name Type Description
Canceled

string

Failed

string

New

string

Pending

string

Provisioning

string

Succeeded

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

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

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.