Billing Role Assignments - List By Billing Profile
Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments?api-version=2020-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
billing
|
path | True |
string |
The ID that uniquely identifies a billing account. |
billing
|
path | True |
string |
The ID that uniquely identifies a billing profile. |
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 |
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
BillingProfileRoleAssignmentList
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments?api-version=2020-05-01
Sample Response
{
"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"
}
]
}
Definitions
Name | Description |
---|---|
Billing |
The role assignment |
Billing |
The list of role assignments. |
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Error |
BillingRoleAssignment
The role assignment
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
name |
string |
Resource name. |
properties.createdByPrincipalId |
string |
The principal Id of the user who created the role assignment. |
properties.createdByPrincipalTenantId |
string |
The tenant Id of the user who created the role assignment. |
properties.createdByUserEmailAddress |
string |
The email address of the user who created the role assignment. |
properties.createdOn |
string |
The date the role assignment was created. |
properties.principalId |
string |
The principal id of the user to whom the role was assigned. |
properties.principalTenantId |
string |
The principal tenant id of the user to whom the role was assigned. |
properties.roleDefinitionId |
string |
The ID of the role definition. |
properties.scope |
string |
The scope at which the role was assigned. |
properties.userAuthenticationType |
string |
The authentication type. |
properties.userEmailAddress |
string |
The email address of the user. |
type |
string |
Resource type. |
BillingRoleAssignmentListResult
The list of role assignments.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link (url) to the next page of results. |
value |
The list of role assignments. |
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. |