role_definitions

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

Overview

Name	role_definitions
Type	Resource
Id	azure.billing.role_definitions

Fields

The following fields are returned by SELECT queries:

get_by_customer

The properties of a role definition.

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 < > % & \ ? /

get_by_billing_profile

The properties of a role definition.

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 < > % & \ ? /

list_by_customer

The list of 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 < > % & \ ? /

get_by_department

The properties of a role definition.

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 < > % & \ ? /

get_by_enrollment_account

The properties of a role definition.

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 < > % & \ ? /

list_by_billing_profile

The list of 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 < > % & \ ? /

get_by_billing_account

The properties of a role definition.

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 < > % & \ ? /

list_by_department

The properties of a role definition.

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 < > % & \ ? /

list_by_enrollment_account

The list of 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 < > % & \ ? /

list_by_billing_account

The list of 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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
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_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.
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.
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_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.
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.
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.
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.

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.
roleDefinitionName	string	The ID that uniquely identifies a role definition.

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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND customerName = '{{ customerName }}' -- required
AND roleDefinitionName = '{{ roleDefinitionName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND roleDefinitionName = '{{ roleDefinitionName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND customerName = '{{ customerName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND departmentName = '{{ departmentName }}' -- required
AND roleDefinitionName = '{{ roleDefinitionName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND enrollmentAccountName = '{{ enrollmentAccountName }}' -- required
AND roleDefinitionName = '{{ roleDefinitionName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND roleDefinitionName = '{{ roleDefinitionName }}' -- required
;

list_by_department

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

SELECT
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND departmentName = '{{ departmentName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND enrollmentAccountName = '{{ enrollmentAccountName }}' -- 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
properties,
tags
FROM azure.billing.role_definitions
WHERE billingAccountName = '{{ billingAccountName }}' -- required
;