Billing Role Definitions - Get By Billing Profile
Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}?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. |
billing
|
path | True |
string |
The ID that uniquely identifies a role definition. |
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
BillingProfileRoleDefinition
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}?api-version=2020-05-01
Sample Response
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}",
"name": "{billingRoleDefinitionName}",
"properties": {
"description": "The Owner role gives the user all permissions including access management rights to the billing profile.",
"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": "Billing profile owner"
},
"type": "Microsoft.Billing/billingAccounts/billingProfiles/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. |
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. |
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. |