InvoiceSectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:invoice_sections> attribute.

Inheritance
builtins.object
InvoiceSectionsOperations

Constructor

InvoiceSectionsOperations(*args, **kwargs)

Methods

begin_create_or_update

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

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

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

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

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

begin_create_or_update

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

begin_create_or_update(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, parameters: _models.InvoiceSection, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.InvoiceSection]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.
parameters
Required
InvoiceSection or IO[bytes]

An invoice section. Is either a InvoiceSection type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[InvoiceSection]

An instance of LROPoller that returns either InvoiceSection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

begin_delete

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

begin_delete(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

get

Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

get(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> InvoiceSection

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

Returns

Type Description
InvoiceSection

InvoiceSection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

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.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, include_deleted: bool = False, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> Iterable[InvoiceSection]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
include_deleted
Required
bool

Can be used to get deleted invoice sections. Default value is False.
filter
Required
str

The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by
Required
str

The orderby query option allows clients to request resources in a particular order. Default value is None.
top
Required
int

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. Default value is None.
skip
Required
int

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
count
Required
bool

The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
search
Required
str

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. Default value is None.

Returns

Type Description
ItemPaged[InvoiceSection]

An iterator like instance of either InvoiceSection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

validate_delete_eligibility

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

validate_delete_eligibility(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> DeleteInvoiceSectionEligibilityResult

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

Returns

Type Description
DeleteInvoiceSectionEligibilityResult

DeleteInvoiceSectionEligibilityResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

Attributes

models 

models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>