invoice_sections

Creates, updates, deletes, gets or lists an invoice_sections resource.

Overview

Name	invoice_sections
Type	Resource
Id	azure.billing.invoice_sections

Fields

The following fields are returned by SELECT queries:

get

An invoice section.

Name	Datatype	Description
properties	object	An invoice section.
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

A list of invoice sections.

Name	Datatype	Description
properties	object	An invoice section.
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		Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list_by_billing_profile	select	billingAccountName, billingProfileName	includeDeleted, filter, orderBy, top, skip, count, search	Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
create_or_update	insert	billingAccountName, billingProfileName, invoiceSectionName		Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
delete	delete	billingAccountName, billingProfileName, invoiceSectionName		Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
validate_delete_eligibility	exec	billingAccountName, billingProfileName, invoiceSectionName		Validates if the invoice section can be deleted. 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.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
includeDeleted	boolean	Can be used to get deleted invoice sections.
orderBy	string	The orderby query option allows clients to request resources in a particular order.
search	string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
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 an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

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

list_by_billing_profile

Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

SELECT
properties,
tags
FROM azure.billing.invoice_sections
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

INSERT examples

create_or_update

Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

INSERT INTO azure.billing.invoice_sections (
data__tags,
data__properties,
billingAccountName,
billingProfileName,
invoiceSectionName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ billingAccountName }}',
'{{ billingProfileName }}',
'{{ invoiceSectionName }}'
RETURNING
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: invoice_sections
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the invoice_sections resource.
    - name: billingProfileName
      value: string
      description: Required parameter for the invoice_sections resource.
    - name: invoiceSectionName
      value: string
      description: Required parameter for the invoice_sections resource.
    - name: tags
      value: object
      description: |
        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 < > % & \ ? /
    - name: properties
      value: object
      description: |
        An invoice section.

DELETE examples

delete

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

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

Lifecycle Methods

validate_delete_eligibility

Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

EXEC azure.billing.invoice_sections.validate_delete_eligibility 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required
;