Share via


Billing Permissions - Check Access By Invoice Section

Provides a list of check access response objects for an invoice section.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess?api-version=2024-04-01

URI Parameters

Name In Required Type Description
billingAccountName
path True

string

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})?)$

The ID that uniquely identifies a billing account.

billingProfileName
path True

string

pattern: ^[a-zA-Z\d-_]{1,128}$

The ID that uniquely identifies a billing profile.

invoiceSectionName
path True

string

pattern: ^[a-zA-Z\d-_]{1,128}$

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 2024-04-01.

Request Body

Name Type Description
actions

string[]

List of actions passed in the request body against which the permissions will be checked.

Responses

Name Type Description
200 OK

CheckAccessResponse[]

The list of check access response objects for an invoice section.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

CheckAccessByInvoiceSection

Sample request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/Q7GV-UUVA-PJA-TGB/checkAccess?api-version=2024-04-01

{
  "actions": [
    "Microsoft.Billing/billingAccounts/read",
    "Microsoft.Subscription/subscriptions/write"
  ]
}

Sample response

[
  {
    "accessDecision": "Allowed",
    "action": "Microsoft.Billing/billingAccounts/read"
  },
  {
    "accessDecision": "NotAllowed",
    "action": "Microsoft.Subscription/subscriptions/write"
  }
]

Definitions

Name Description
AccessDecision

Access Decision, specifies access is allowed or not.

CheckAccessRequest

Request to check access.

CheckAccessResponse

The properties of a check access response.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

AccessDecision

Access Decision, specifies access is allowed or not.

Value Description
Other
Allowed
NotAllowed

CheckAccessRequest

Request to check access.

Name Type Description
actions

string[]

List of actions passed in the request body against which the permissions will be checked.

CheckAccessResponse

The properties of a check access response.

Name Type Description
accessDecision

AccessDecision

Access Decision, specifies access is allowed or not.

action

string

Gets or sets an action.

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.