Billing Role Definitions - List By Department
Lists the role definitions for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions?api-version=2019-10-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
billing
|
path | True |
string |
The ID that uniquely identifies a billing account. |
department
|
path | True |
string |
The ID that uniquely identifies a department. |
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
DepartmentRoleDefinitionsList
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions?api-version=2019-10-01-preview
Sample Response
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840",
"name": "fb2cf67f-be5b-42e7-8025-4683c668f840",
"properties": {
"description": "The department administrator role gives the user read/write permissions including access management rights to an Enrollment Department and its accounts.",
"permissions": [
{
"actions": [
"Microsoft.Billing/billingAccounts/departments/read",
"Microsoft.Billing/billingAccounts/departments/write",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/read",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/write",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write"
]
}
],
"roleName": "Department administrator"
},
"type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions"
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/db609904-a47f-4794-9be8-9bd86fbffd8a",
"name": "db609904-a47f-4794-9be8-9bd86fbffd8a",
"properties": {
"description": "The department reader role gives the user read-only permissions to an Enrollment Department and its accounts.",
"permissions": [
{
"actions": [
"Microsoft.Billing/billingAccounts/departments/read",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/read",
"Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read"
]
}
],
"roleName": "Department reader"
},
"type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions"
}
]
}
Definitions
Name | Description |
---|---|
Billing |
The set of allowed action and not allowed actions a caller has on a billing account |
Billing |
The properties of a role definition. |
Billing |
The list of role definitions. |
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 |
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. |