permissions

Creates, updates, deletes, gets or lists a permissions resource.

Overview

Name	permissions
Type	Resource
Id	azure.billing.permissions

Fields

The following fields are returned by SELECT queries:

list_by_customer

The list of billingPermissions a caller has on a customer.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

list_by_billing_profile

The list of billingPermissions a caller has on a billing profile.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

list_by_customer_at_billing_account

The list of billingPermissions a caller has on a customer.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

list_by_department

The list of billingPermissions a caller has on a department.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

list_by_enrollment_account

The list of billingPermissions a caller has on an enrollment account.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

list_by_billing_account

The list of billingPermissions a caller has on a billing account.

Name	Datatype	Description
actions	array	The set of actions that the caller is allowed to perform.
notActions	array	The set of actions that the caller is not allowed to perform.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_customer	select	billingAccountName, billingProfileName, customerName		Lists the billing permissions the caller has for a customer.
list_by_billing_profile	select	billingAccountName, billingProfileName		Lists the billing permissions the caller has on a billing profile.
list_by_customer_at_billing_account	select	billingAccountName, customerName		Lists the billing permissions the caller has for a customer at billing account level.
list_by_department	select	billingAccountName, departmentName		Lists the billing permissions the caller has for a department.
list_by_enrollment_account	select	billingAccountName, enrollmentAccountName		Lists the billing permissions the caller has for an enrollment account.
list_by_billing_account	select	billingAccountName		Lists the billing permissions the caller has on a billing account.
check_access_by_billing_profile	exec	billingAccountName, billingProfileName		Provides a list of check access response objects for a billing profile.
check_access_by_customer	exec	billingAccountName, billingProfileName, customerName		Provides a list of check access response objects for a customer.
check_access_by_invoice_section	exec	billingAccountName, billingProfileName, invoiceSectionName		Provides a list of check access response objects for an invoice section.
check_access_by_billing_account	exec	billingAccountName		Provides a list of check access response objects for a billing account.
check_access_by_department	exec	billingAccountName, departmentName		Provides a list of check access response objects for a department.
check_access_by_enrollment_account	exec	billingAccountName, enrollmentAccountName		Provides a list of check access response objects for an enrollment account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
customerName	string	The ID that uniquely identifies a customer.
departmentName	string	The name of the department.
enrollmentAccountName	string	The name of the enrollment account.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.

SELECT examples

list_by_customer

Lists the billing permissions the caller has for a customer.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND customerName = '{{ customerName }}' -- required
;

list_by_billing_profile

Lists the billing permissions the caller has on a billing profile.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
;

list_by_customer_at_billing_account

Lists the billing permissions the caller has for a customer at billing account level.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND customerName = '{{ customerName }}' -- required
;

list_by_department

Lists the billing permissions the caller has for a department.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND departmentName = '{{ departmentName }}' -- required
;

list_by_enrollment_account

Lists the billing permissions the caller has for an enrollment account.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND enrollmentAccountName = '{{ enrollmentAccountName }}' -- required
;

list_by_billing_account

Lists the billing permissions the caller has on a billing account.

SELECT
actions,
notActions
FROM azure.billing.permissions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
;

Lifecycle Methods

check_access_by_billing_profile

Provides a list of check access response objects for a billing profile.

EXEC azure.billing.permissions.check_access_by_billing_profile 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;

check_access_by_customer

Provides a list of check access response objects for a customer.

EXEC azure.billing.permissions.check_access_by_customer 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@customerName='{{ customerName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;

check_access_by_invoice_section

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

EXEC azure.billing.permissions.check_access_by_invoice_section 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;

check_access_by_billing_account

Provides a list of check access response objects for a billing account.

EXEC azure.billing.permissions.check_access_by_billing_account 
@billingAccountName='{{ billingAccountName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;

check_access_by_department

Provides a list of check access response objects for a department.

EXEC azure.billing.permissions.check_access_by_department 
@billingAccountName='{{ billingAccountName }}' --required, 
@departmentName='{{ departmentName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;

check_access_by_enrollment_account

Provides a list of check access response objects for an enrollment account.

EXEC azure.billing.permissions.check_access_by_enrollment_account 
@billingAccountName='{{ billingAccountName }}' --required, 
@enrollmentAccountName='{{ enrollmentAccountName }}' --required 
@@json=
'{
"actions": "{{ actions }}"
}'
;