role_assignments_by_invoice_sections

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

Overview

Name	role_assignments_by_invoice_sections
Type	Resource
Id	azure.billing.role_assignments_by_invoice_sections

Fields

The following fields are returned by SELECT queries:

get

The properties of the billing role assignment.

Name	Datatype	Description
properties	object	The properties of the billing role assignment.
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

The list of the billing role assignments.

Name	Datatype	Description
properties	object	The properties of the billing role assignment.
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	select	billingAccountName, billingProfileName, invoiceSectionName, billingRoleAssignmentName		Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
list	select	billingAccountName, billingProfileName, invoiceSectionName	filter, top, skip	Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
create	insert	billingAccountName, billingProfileName, invoiceSectionName, data__roleDefinitionId		Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
delete	delete	billingAccountName, billingProfileName, invoiceSectionName, billingRoleAssignmentName		Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer 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.
billingRoleAssignmentName	string	The ID that uniquely identifies a role assignment.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
skip	integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	integer (int64)	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

SELECT examples

get

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

SELECT
properties,
tags
FROM azure.billing.role_assignments_by_invoice_sections
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND billingRoleAssignmentName = '{{ billingRoleAssignmentName }}' -- required
;

list

Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

SELECT
properties,
tags
FROM azure.billing.role_assignments_by_invoice_sections
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND filter = '{{ filter }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
;

INSERT examples

create

Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

INSERT INTO azure.billing.role_assignments_by_invoice_sections (
data__principalPuid,
data__principalId,
data__principalTenantId,
data__roleDefinitionId,
data__scope,
data__userAuthenticationType,
data__userEmailAddress,
billingAccountName,
billingProfileName,
invoiceSectionName
)
SELECT 
'{{ principalPuid }}',
'{{ principalId }}',
'{{ principalTenantId }}',
'{{ roleDefinitionId }}' /* required */,
'{{ scope }}',
'{{ userAuthenticationType }}',
'{{ userEmailAddress }}',
'{{ billingAccountName }}',
'{{ billingProfileName }}',
'{{ invoiceSectionName }}'
RETURNING
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: role_assignments_by_invoice_sections
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the role_assignments_by_invoice_sections resource.
    - name: billingProfileName
      value: string
      description: Required parameter for the role_assignments_by_invoice_sections resource.
    - name: invoiceSectionName
      value: string
      description: Required parameter for the role_assignments_by_invoice_sections resource.
    - name: principalPuid
      value: string
      description: |
        The principal PUID of the user to whom the role was assigned.
    - name: principalId
      value: string
      description: |
        The object id of the user to whom the role was assigned.
    - name: principalTenantId
      value: string
      description: |
        The principal tenant id of the user to whom the role was assigned.
    - name: roleDefinitionId
      value: string
      description: |
        The ID of the role definition.
    - name: scope
      value: string
      description: |
        The scope at which the role was assigned.
    - name: userAuthenticationType
      value: string
      description: |
        The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.
    - name: userEmailAddress
      value: string
      description: |
        The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.

DELETE examples

delete

Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

DELETE FROM azure.billing.role_assignments_by_invoice_sections
WHERE billingAccountName = '{{ billingAccountName }}' --required
AND billingProfileName = '{{ billingProfileName }}' --required
AND invoiceSectionName = '{{ invoiceSectionName }}' --required
AND billingRoleAssignmentName = '{{ billingRoleAssignmentName }}' --required
;