role_definitions

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

Overview

Name	role_definitions
Type	Resource
Id	azure.billing.role_definitions

Fields

vw_role_definitions

Name	Datatype	Description
description	text	field from the properties object
billingAccountName	text	field from the properties object
billingProfileName	text	field from the properties object
customerName	text	field from the properties object
permissions	text	field from the properties object
roleDefinitionName	text	field from the properties object
role_name	text	field from the properties object
tags	text	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 < > % & \ ? /

role_definitions

Name	Datatype	Description
properties	object	The properties of a role definition.
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 < > % & \ ? /

Methods

Name	Accessible by	Required Params	Description
get_by_billing_account	SELECT	billingAccountName, roleDefinitionName	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.
get_by_billing_profile	SELECT	billingAccountName, billingProfileName, roleDefinitionName	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_customer	SELECT	billingAccountName, billingProfileName, customerName, roleDefinitionName	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_department	SELECT	billingAccountName, departmentName, roleDefinitionName	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	billingAccountName, enrollmentAccountName, roleDefinitionName	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_account	SELECT	billingAccountName	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.
list_by_billing_profile	SELECT	billingAccountName, billingProfileName	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_customer	SELECT	billingAccountName, billingProfileName, customerName	Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
list_by_department	SELECT	billingAccountName, departmentName	List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_enrollment_account	SELECT	billingAccountName, enrollmentAccountName	List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT examples

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.

vw_role_definitions

SELECT
description,
billingAccountName,
billingProfileName,
customerName,
permissions,
roleDefinitionName,
role_name,
tags
FROM azure.billing.vw_role_definitions
WHERE billingAccountName = '{{ billingAccountName }}';

role_definitions

SELECT
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}';