BillingSubscriptionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_subscriptions> attribute.

Constructor

BillingSubscriptionsOperations(*args, **kwargs)

Methods

begin_move	Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
get	Gets a subscription 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 subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
list_by_billing_profile	Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
list_by_customer	Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_invoice_section	Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
update	Updates the properties of a billing subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
validate_move	Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

begin_move

Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

begin_move(billing_account_name: str, parameters: _models.TransferBillingSubscriptionRequestProperties, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BillingSubscription]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
parameters Required	TransferBillingSubscriptionRequestProperties or IO Request parameters that are provided to the move subscription operation. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

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

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

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_billing_account

Lists the subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

list_by_billing_account(billing_account_name: str, **kwargs: Any) -> Iterable[BillingSubscription]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[BillingSubscription]	An iterator like instance of either BillingSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_billing_profile

Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> Iterable[BillingSubscription]

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
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[BillingSubscription]	An iterator like instance of either BillingSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_customer

Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

list_by_customer(billing_account_name: str, customer_name: str, **kwargs: Any) -> Iterable[BillingSubscription]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[BillingSubscription]	An iterator like instance of either BillingSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_invoice_section

Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> Iterable[BillingSubscription]

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
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[BillingSubscription]	An iterator like instance of either BillingSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates the properties of a billing subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

update(billing_account_name: str, parameters: _models.BillingSubscription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BillingSubscription

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
parameters Required	BillingSubscription or IO Request parameters that are provided to the update billing subscription operation. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

validate_move

Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

validate_move(billing_account_name: str, parameters: _models.TransferBillingSubscriptionRequestProperties, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidateSubscriptionTransferEligibilityResult

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
parameters Required	TransferBillingSubscriptionRequestProperties or IO Request parameters that are provided to the validate move eligibility operation. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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