BillingSubscriptionsAliasesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_subscriptions_aliases> attribute.

Inheritance
builtins.object
BillingSubscriptionsAliasesOperations

Constructor

BillingSubscriptionsAliasesOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.
get

Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
list_by_billing_account

Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.

begin_create_or_update

Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.

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

Parameters

Name Description
billing_account_name
Required
str

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

The ID that uniquely identifies a subscription alias. Required.
parameters
Required
BillingSubscriptionAlias or IO[bytes]

A billing subscription alias. Is either a BillingSubscriptionAlias type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[BillingSubscriptionAlias]

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

Exceptions

Type Description
HttpResponseError
See also

get

Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.

get(billing_account_name: str, alias_name: str, **kwargs: Any) -> BillingSubscriptionAlias

Parameters

Name Description
billing_account_name
Required
str

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

The ID that uniquely identifies a subscription alias. Required.

Returns

Type Description
BillingSubscriptionAlias

BillingSubscriptionAlias or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_account

Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.

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) -> Iterable[BillingSubscriptionAlias]

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 subscriptions. 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[BillingSubscriptionAlias]

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