BillingRequestsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:billing_requests> attribute.

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 <xref:JSON> 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 one of the following types: BillingRequest, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[BillingRequest]	An instance of LROPoller that returns BillingRequest. The BillingRequest is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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. The BillingRequest is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[BillingRequest]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.

Keyword-Only Parameters

Name	Description
filter	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
order_by	str The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
top	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. Default value: None
skip	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. Default value: None
count	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. Default value: None
search	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. Default value: None

Returns

Type	Description
ItemPaged[BillingRequest]	An iterator like instance of BillingRequest

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[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.

Keyword-Only Parameters

Name	Description
filter	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
order_by	str The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
top	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. Default value: None
skip	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. Default value: None
count	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. Default value: None
search	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. Default value: None

Returns

Type	Description
ItemPaged[BillingRequest]	An iterator like instance of BillingRequest

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[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.

Keyword-Only Parameters

Name	Description
filter	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
order_by	str The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
top	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. Default value: None
skip	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. Default value: None
count	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. Default value: None
search	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. Default value: None

Returns

Type	Description
ItemPaged[BillingRequest]	An iterator like instance of BillingRequest

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[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.

Keyword-Only Parameters

Name	Description
filter	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
order_by	str The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
top	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. Default value: None
skip	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. Default value: None
count	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. Default value: None
search	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. Default value: None

Returns

Type	Description
ItemPaged[BillingRequest]	An iterator like instance of BillingRequest

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[BillingRequest]

Keyword-Only Parameters

Name	Description
filter	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
order_by	str The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
top	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. Default value: None
skip	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. Default value: None
count	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. Default value: None
search	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. Default value: None

Returns

Type	Description
ItemPaged[BillingRequest]	An iterator like instance of BillingRequest

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?