BillingRequestsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_requests> attribute.

Inheritance
builtins.object
BillingRequestsOperations

Constructor

BillingRequestsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a billing request.
get

Gets a billing request by its ID.
list_by_billing_account

The list of billing requests submitted for the billing account.
list_by_billing_profile

The list of billing requests submitted for the billing profile.
list_by_customer

The list of billing requests submitted for the customer.
list_by_invoice_section

The list of billing requests submitted for the invoice section.
list_by_user

The list of billing requests submitted by a user.

begin_create_or_update

Create or update a billing request.

begin_create_or_update(billing_request_name: str, parameters: _models.BillingRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BillingRequest]

Parameters

Name Description
billing_request_name
Required
str

The ID that uniquely identifies a billing request. Required.
parameters
Required
BillingRequest or IO[bytes]

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. Is either a BillingRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[BillingRequest]

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

Exceptions

Type Description
HttpResponseError
See also

get

Gets a billing request by its ID.

get(billing_request_name: str, **kwargs: Any) -> BillingRequest

Parameters

Name Description
billing_request_name
Required
str

The ID that uniquely identifies a billing request. Required.

Returns

Type Description
BillingRequest

BillingRequest or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_account

The list of billing requests submitted for the billing account.

list_by_billing_account(billing_account_name: str, 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[BillingRequest]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
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[BillingRequest]

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

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_profile

The list of billing requests submitted for the billing profile.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, 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[BillingRequest]

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.
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[BillingRequest]

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

Exceptions

Type Description
HttpResponseError
See also

list_by_customer

The list of billing requests submitted for the customer.

list_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, 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[BillingRequest]

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.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.
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[BillingRequest]

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

Exceptions

Type Description
HttpResponseError
See also

list_by_invoice_section

The list of billing requests submitted for the invoice section.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, 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[BillingRequest]

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.
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[BillingRequest]

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

Exceptions

Type Description
HttpResponseError
See also

list_by_user

The list of billing requests submitted by a user.

list_by_user(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[BillingRequest]

Parameters

Name Description
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[BillingRequest]

An iterator like instance of either BillingRequest 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'>