billing_role_definition

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

Overview

Name	billing_role_definition
Type	Resource
Id	azure.billing.billing_role_definition

Fields

The following fields are returned by SELECT queries:

get_by_customer

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_invoice_section

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_customer

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_invoice_section

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_department

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_enrollment_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_department

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_enrollment_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The role description.
permissions	array	The billingPermissions the role has.
roleName	string	The name of the role. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_customer	select	billing_account_name, billing_profile_name, customer_name, role_definition_name		Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
get_by_invoice_section	select	billing_account_name, billing_profile_name, invoice_section_name, role_definition_name		Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list_by_customer	select	billing_account_name, billing_profile_name, customer_name		Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
list_by_invoice_section	select	billing_account_name, billing_profile_name, invoice_section_name		Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
get_by_billing_profile	select	billing_account_name, billing_profile_name, role_definition_name		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_by_department	select	billing_account_name, department_name, role_definition_name		Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get_by_enrollment_account	select	billing_account_name, enrollment_account_name, role_definition_name		Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_billing_profile	select	billing_account_name, billing_profile_name		Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
list_by_department	select	billing_account_name, department_name		List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_enrollment_account	select	billing_account_name, enrollment_account_name		List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get_by_billing_account	select	billing_account_name, role_definition_name		Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
list_by_billing_account	select	billing_account_name		Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

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
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.
customer_name	string	The ID that uniquely identifies a customer. Required.
department_name	string	The name of the department. Required.
enrollment_account_name	string	The name of the enrollment account. Required.
invoice_section_name	string	The ID that uniquely identifies an invoice section. Required.
role_definition_name	string	The ID that uniquely identifies a role definition. Required.

SELECT examples

get_by_customer

Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

get_by_invoice_section

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

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

list_by_customer

Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
;

list_by_invoice_section

Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
;

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.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

get_by_department

Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND department_name = '{{ department_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

get_by_enrollment_account

Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND enrollment_account_name = '{{ enrollment_account_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

list_by_billing_profile

Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
;

list_by_department

List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND department_name = '{{ department_name }}' -- required
;

list_by_enrollment_account

List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND enrollment_account_name = '{{ enrollment_account_name }}' -- required
;

get_by_billing_account

Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND role_definition_name = '{{ role_definition_name }}' -- required
;

list_by_billing_account

Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

SELECT
id,
name,
description,
permissions,
roleName,
systemData,
tags,
type
FROM azure.billing.billing_role_definition
WHERE billing_account_name = '{{ billing_account_name }}' -- required
;