Billing Role Definitions - Get By Invoice Section

Reference

Service:: Billing

API Version:: 2019-10-01-preview

Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}?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.
billingProfileName	path	True	string	The ID that uniquely identifies a billing profile.
billingRoleDefinitionName	path	True	string	The ID that uniquely identifies a role definition.
invoiceSectionName	path	True	string	The ID that uniquely identifies an invoice section.
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	BillingRoleDefinition	OK. The request has succeeded.
Other Status Codes	ErrorResponse	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

InvoiceSectionRoleDefinition

Sample Request

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

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}",
  "name": "{billingRoleDefinitionName}",
  "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"
}

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.
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	BillingPermissionsProperties[]	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	ErrorSubDetails[]	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	ErrorDetails	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.