BillingProfilesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_profiles> attribute.

Inheritance

builtins.object

BillingProfilesOperations

Constructor

BillingProfilesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
begin_delete	Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
get	Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
list_by_billing_account	Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.
validate_delete_eligibility	Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

begin_create_or_update

Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.

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

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.
parameters Required	BillingProfile or IO[bytes] A billing profile. Is either a BillingProfile type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[BillingProfile]	An instance of AsyncLROPoller that returns either BillingProfile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_delete

Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

async begin_delete(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> AsyncLROPoller[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.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

get

Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

async get(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> BillingProfile

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.

Returns

Type	Description
BillingProfile	BillingProfile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

list_by_billing_account

Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.

list_by_billing_account(billing_account_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) -> AsyncIterable[BillingProfile]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
include_deleted Required	bool Can be used to get deleted billing profiles. 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
AsyncItemPaged[BillingProfile]	An iterator like instance of either BillingProfile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

validate_delete_eligibility

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

async validate_delete_eligibility(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> DeleteBillingProfileEligibilityResult

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.

Returns

Type	Description
DeleteBillingProfileEligibilityResult	DeleteBillingProfileEligibilityResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

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'>