azure.mgmt.billing.operations module¶

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.AgreementsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s agreements attribute.

get(billing_account_name: str, agreement_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Agreement[source]¶

Gets an agreement by ID.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
agreement_name (str) – The ID that uniquely identifies an agreement. Required.
expand (str) – May be used to expand the participants. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Agreement or the result of cls(response)

Return type

Agreement

Raises

list_by_billing_account(billing_account_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Agreement][source]¶

Lists the agreements for a billing account.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
expand (str) – May be used to expand the participants. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Agreement]

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.AvailableBalancesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s available_balances attribute.

get(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.AvailableBalance[source]¶

The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AvailableBalance or the result of cls(response)

Return type

AvailableBalance

Raises

LROPoller[BillingAccount]

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingAccountsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_accounts attribute.

begin_update(billing_account_name: str, parameters: _models.BillingAccountUpdateRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BillingAccount][source]¶

begin_update(billing_account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BillingAccount]

Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
parameters (BillingAccountUpdateRequest or IO) – Request parameters that are provided to the update billing account operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

Raises

get(billing_account_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingAccount[source]¶

Gets a billing account by its ID.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
expand (str) – May be used to expand the soldTo, invoice sections and billing profiles. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingAccount or the result of cls(response)

Return type

BillingAccount

Raises

list(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingAccount][source]¶

Lists the billing accounts that a user has access to.

Parameters: expand (str) – May be used to expand the soldTo, invoice sections and billing profiles. Default value is None.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BillingAccount or the result of cls(response)
Return type: ItemPaged[BillingAccount]
Raises: HttpResponseError –

list_invoice_sections_by_create_subscription_permission(billing_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.InvoiceSectionWithCreateSubPermission][source]¶

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either InvoiceSectionWithCreateSubPermission or the result of cls(response)
Return type: ItemPaged[InvoiceSectionWithCreateSubPermission]
Raises: HttpResponseError –

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingPeriodsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_periods attribute.

get(billing_period_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingPeriod[source]¶

Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.

Parameters: billing_period_name (str) – The name of a BillingPeriod resource. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: BillingPeriod or the result of cls(response)
Return type: BillingPeriod
Raises: HttpResponseError –

list(filter: Optional[str] = None, skiptoken: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingPeriod][source]¶

Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.

Parameters

filter (str) – May be used to filter billing periods by billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Default value is None.
skiptoken (str) – Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Default value is None.
top (int) – May be used to limit the number of results to the most recent N billing periods. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[BillingPeriod]

Raises

ItemPaged[BillingPermissionsProperties]

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingPermissionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_permissions attribute.

list_by_billing_account(billing_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingPermissionsProperties][source]¶

Lists the billing permissions the caller has on a billing account.

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BillingPermissionsProperties or the result of cls(response)
Return type: ItemPaged[BillingPermissionsProperties]
Raises: HttpResponseError –

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingPermissionsProperties][source]¶

Lists the billing permissions the caller has on a billing profile.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingPermissionsProperties]

list_by_customer(billing_account_name: str, customer_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingPermissionsProperties][source]¶

Lists the billing permissions the caller has for a customer.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingPermissionsProperties]

list_by_invoice_sections(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingPermissionsProperties][source]¶

Lists the billing permissions the caller has on an invoice section.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

LROPoller[BillingProfile]

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingProfilesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_profiles attribute.

begin_create_or_update(billing_account_name: str, billing_profile_name: str, parameters: _models.BillingProfile, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BillingProfile][source]¶

begin_create_or_update(billing_account_name: str, billing_profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BillingProfile]

Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
parameters (BillingProfile or IO) – The new or updated billing profile. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

Raises

get(billing_account_name: str, billing_profile_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingProfile[source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
expand (str) – May be used to expand the invoice sections. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingProfile or the result of cls(response)

Return type

BillingProfile

Raises

ItemPaged[BillingProfile]

list_by_billing_account(billing_account_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingProfile][source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
expand (str) – May be used to expand the invoice sections. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingPropertyOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_property attribute.

get(**kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingProperty[source]¶

Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: BillingProperty or the result of cls(response)
Return type: BillingProperty
Raises: HttpResponseError –

update(parameters: _models.BillingProperty, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BillingProperty[source]¶

update(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BillingProperty

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

Parameters

parameters (BillingProperty or IO) – Request parameters that are provided to the update billing property operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

BillingProperty or the result of cls(response)

Return type

BillingProperty

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingRoleAssignmentsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_role_assignments attribute.

delete_by_billing_account(billing_account_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

delete_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

delete_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

get_by_billing_account(billing_account_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

get_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

get_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_assignment_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleAssignment[source]¶

Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.
billing_role_assignment_name (str) – The ID that uniquely identifies a role assignment. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleAssignment or the result of cls(response)

Return type

Raises

ItemPaged[BillingRoleAssignment]

list_by_billing_account(billing_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleAssignment][source]¶

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

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BillingRoleAssignment or the result of cls(response)
Return type: ItemPaged[BillingRoleAssignment]
Raises: HttpResponseError –

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleAssignment][source]¶

Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingRoleAssignment]

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleAssignment][source]¶

Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingRoleDefinitionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_role_definitions attribute.

get_by_billing_account(billing_account_name: str, billing_role_definition_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleDefinition[source]¶

Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_role_definition_name (str) – The ID that uniquely identifies a role definition. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleDefinition or the result of cls(response)

Return type

BillingRoleDefinition

Raises

get_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_definition_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleDefinition[source]¶

Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
billing_role_definition_name (str) – The ID that uniquely identifies a role definition. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleDefinition or the result of cls(response)

Return type

BillingRoleDefinition

Raises

get_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_definition_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingRoleDefinition[source]¶

Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.
billing_role_definition_name (str) – The ID that uniquely identifies a role definition. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BillingRoleDefinition or the result of cls(response)

Return type

BillingRoleDefinition

Raises

ItemPaged[BillingRoleDefinition]

list_by_billing_account(billing_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleDefinition][source]¶

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

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BillingRoleDefinition or the result of cls(response)
Return type: ItemPaged[BillingRoleDefinition]
Raises: HttpResponseError –

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleDefinition][source]¶

Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingRoleDefinition]

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingRoleDefinition][source]¶

Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

LROPoller[BillingSubscription]

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.BillingSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s billing_subscriptions attribute.

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

begin_move(billing_account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BillingSubscription]

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.

Parameters

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

Keyword Arguments

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

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

Return type

Raises

ItemPaged[BillingSubscription]

get(billing_account_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.BillingSubscription[source]¶

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

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: BillingSubscription or the result of cls(response)
Return type: BillingSubscription
Raises: HttpResponseError –

list_by_billing_account(billing_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingSubscription][source]¶

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

Parameters: billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either BillingSubscription or the result of cls(response)
Return type: ItemPaged[BillingSubscription]
Raises: HttpResponseError –

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingSubscription][source]¶

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.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingSubscription]

list_by_customer(billing_account_name: str, customer_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingSubscription][source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[BillingSubscription]

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.BillingSubscription][source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(billing_account_name: str, parameters: _models.BillingSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BillingSubscription[source]¶

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

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.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
parameters (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 Arguments

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

BillingSubscription or the result of cls(response)

Return type

BillingSubscription

Raises

ValidateSubscriptionTransferEligibilityResult

validate_move(billing_account_name: str, parameters: _models.TransferBillingSubscriptionRequestProperties, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateSubscriptionTransferEligibilityResult[source]¶

validate_move(billing_account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateSubscriptionTransferEligibilityResult

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.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
parameters (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 Arguments

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

ValidateSubscriptionTransferEligibilityResult or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.CustomersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s customers attribute.

get(billing_account_name: str, customer_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Customer[source]¶

Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.
expand (str) – May be used to expand enabledAzurePlans and resellers. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Customer or the result of cls(response)

Return type

Customer

Raises

list_by_billing_account(billing_account_name: str, search: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Customer][source]¶

Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
search (str) – Used for searching customers by their name. Any customer with name containing the search text will be included in the response. Default value is None.
filter (str) – May be used to filter the list of customers. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Customer]

Raises

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, search: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Customer][source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
search (str) – Used for searching customers by their name. Any customer with name containing the search text will be included in the response. Default value is None.
filter (str) – May be used to filter the list of customers. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Customer]

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.EnrollmentAccountsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s enrollment_accounts attribute.

get(name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.EnrollmentAccountSummary[source]¶

Gets a enrollment account by name.

Parameters: name (str) – Enrollment Account name. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: EnrollmentAccountSummary or the result of cls(response)
Return type: EnrollmentAccountSummary
Raises: HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.EnrollmentAccountSummary][source]¶

Lists the enrollment accounts the caller has access to.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either EnrollmentAccountSummary or the result of cls(response)
Return type: ItemPaged[EnrollmentAccountSummary]
Raises: HttpResponseError –

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.InstructionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s instructions attribute.

get(billing_account_name: str, billing_profile_name: str, instruction_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Instruction[source]¶

Get the instruction by name. These are custom billing instructions and are only applicable for certain customers.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
instruction_name (str) – Instruction Name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Instruction or the result of cls(response)

Return type

Instruction

Raises

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Instruction][source]¶

Lists the instructions by billing profile id.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Instruction]

Raises

put(billing_account_name: str, billing_profile_name: str, instruction_name: str, parameters: _models.Instruction, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Instruction[source]¶

put(billing_account_name: str, billing_profile_name: str, instruction_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Instruction

Creates or updates an instruction. These are custom billing instructions and are only applicable for certain customers.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
instruction_name (str) – Instruction Name. Required.
parameters (Instruction or IO) – The new instruction. Is either a model type or a IO type. Required.

Keyword Arguments

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

Instruction or the result of cls(response)

Return type

Instruction

Raises

LROPoller[InvoiceSection]

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.InvoiceSectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s invoice_sections attribute.

begin_create_or_update(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, parameters: _models.InvoiceSection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InvoiceSection][source]¶

begin_create_or_update(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InvoiceSection]

Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.
parameters (InvoiceSection or IO) – The new or updated invoice section. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

Raises

get(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.InvoiceSection[source]¶

Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InvoiceSection or the result of cls(response)

Return type

InvoiceSection

Raises

ItemPaged[InvoiceSection]

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.InvoiceSection][source]¶

Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.InvoicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s invoices attribute.

begin_download_billing_subscription_invoice(invoice_name: str, download_token: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.billing.models._models_py3.DownloadUrl][source]¶

Gets a URL to download an invoice.

Parameters

invoice_name (str) – The ID that uniquely identifies an invoice. Required.
download_token (str) – Download token with document source and document ID. Required.

Keyword Arguments

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

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

Return type

Raises

begin_download_invoice(billing_account_name: str, invoice_name: str, download_token: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.billing.models._models_py3.DownloadUrl][source]¶

Gets a URL to download an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
invoice_name (str) – The ID that uniquely identifies an invoice. Required.
download_token (str) – Download token with document source and document ID. Required.

Keyword Arguments

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

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

Return type

Raises

begin_download_multiple_billing_profile_invoices(billing_account_name: str, download_urls: List[str], *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DownloadUrl][source]¶

begin_download_multiple_billing_profile_invoices(billing_account_name: str, download_urls: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DownloadUrl]

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
download_urls (list[str] or IO) – An array of download urls for individual documents. Is either a list type or a IO type. Required.

Keyword Arguments

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

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

Return type

Raises

begin_download_multiple_billing_subscription_invoices(download_urls: List[str], *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DownloadUrl][source]¶

begin_download_multiple_billing_subscription_invoices(download_urls: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DownloadUrl]

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.

Parameters

download_urls (list[str] or IO) – An array of download urls for individual documents. Is either a list type or a IO type. Required.

Keyword Arguments

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

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

Return type

Raises

get(billing_account_name: str, invoice_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Invoice[source]¶

Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
invoice_name (str) – The ID that uniquely identifies an invoice. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Invoice or the result of cls(response)

Return type

Invoice

Raises

get_by_id(invoice_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Invoice[source]¶

Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters: invoice_name (str) – The ID that uniquely identifies an invoice. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Invoice or the result of cls(response)
Return type: Invoice
Raises: HttpResponseError –

get_by_subscription_and_invoice_id(invoice_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Invoice[source]¶

Gets an invoice by subscription ID and invoice ID.

Parameters: invoice_name (str) – The ID that uniquely identifies an invoice. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Invoice or the result of cls(response)
Return type: Invoice
Raises: HttpResponseError –

list_by_billing_account(billing_account_name: str, period_start_date: str, period_end_date: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Invoice][source]¶

Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
period_start_date (str) – The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.
period_end_date (str) – The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Invoice]

Raises

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, period_start_date: str, period_end_date: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Invoice][source]¶

Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
period_start_date (str) – The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.
period_end_date (str) – The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Invoice]

Raises

list_by_billing_subscription(period_start_date: str, period_end_date: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Invoice][source]¶

Lists the invoices for a subscription.

Parameters

period_start_date (str) – Invoice period start date. Required.
period_end_date (str) – Invoice period end date. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Invoice]

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Operation][source]¶

Lists the available billing REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.PoliciesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s policies attribute.

get_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Policy[source]¶

Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Policy or the result of cls(response)

Return type

Policy

Raises

get_by_customer(billing_account_name: str, customer_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.CustomerPolicy[source]¶

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CustomerPolicy or the result of cls(response)

Return type

CustomerPolicy

Raises

update(billing_account_name: str, billing_profile_name: str, parameters: _models.Policy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Policy[source]¶

update(billing_account_name: str, billing_profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Policy

Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
parameters (Policy or IO) – Request parameters that are provided to the update policies operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

Policy or the result of cls(response)

Return type

Policy

Raises

update_customer(billing_account_name: str, customer_name: str, parameters: _models.CustomerPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CustomerPolicy[source]¶

update_customer(billing_account_name: str, customer_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CustomerPolicy

Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.
parameters (CustomerPolicy or IO) – Request parameters that are provided to the update policies operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

CustomerPolicy or the result of cls(response)

Return type

CustomerPolicy

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.ProductsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s products attribute.

get(billing_account_name: str, product_name: str, **kwargs: Any) → azure.mgmt.billing.models._models_py3.Product[source]¶

Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
product_name (str) – The ID that uniquely identifies a product. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Product or the result of cls(response)

Return type

Product

Raises

list_by_billing_account(billing_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Product][source]¶

Lists the products for a billing account. These don’t include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
filter (str) – May be used to filter by product type. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value are separated by a colon (:). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Product][source]¶

Lists the products for a billing profile. These don’t include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
filter (str) – May be used to filter by product type. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value are separated by a colon (:). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_by_customer(billing_account_name: str, customer_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Product][source]¶

Lists the products for a customer. These don’t include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
customer_name (str) – The ID that uniquely identifies a customer. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Product][source]¶

Lists the products for an invoice section. These don’t include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
invoice_section_name (str) – The ID that uniquely identifies an invoice section. Required.
filter (str) – May be used to filter by product type. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value are separated by a colon (:). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

move(billing_account_name: str, product_name: str, parameters: _models.TransferProductRequestProperties, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.Product][source]¶

move(billing_account_name: str, product_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.Product]

Moves a product’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 only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
product_name (str) – The ID that uniquely identifies a product. Required.
parameters (TransferProductRequestProperties or IO) – Request parameters that are provided to the move product operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

Product or None or the result of cls(response)

Return type

Product or None

Raises

update(billing_account_name: str, product_name: str, parameters: _models.Product, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Product[source]¶

update(billing_account_name: str, product_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Product

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

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
product_name (str) – The ID that uniquely identifies a product. Required.
parameters (Product or IO) – Request parameters that are provided to the update product operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

Product or the result of cls(response)

Return type

Product

Raises

ValidateProductTransferEligibilityResult

validate_move(billing_account_name: str, product_name: str, parameters: _models.TransferProductRequestProperties, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateProductTransferEligibilityResult[source]¶

validate_move(billing_account_name: str, product_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateProductTransferEligibilityResult

Validates if a product’s charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
product_name (str) – The ID that uniquely identifies a product. Required.
parameters (TransferProductRequestProperties or IO) – Request parameters that are provided to the validate move eligibility operation. Is either a model type or a IO type. Required.

Keyword Arguments

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

ValidateProductTransferEligibilityResult or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.ReservationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s reservations attribute.

list_by_billing_account(billing_account_name: str, filter: Optional[str] = None, orderby: Optional[str] = None, refresh_summary: Optional[str] = None, selected_state: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Reservation][source]¶

Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
filter (str) – May be used to filter by reservation properties. The filter supports ‘eq’, ‘or’, and ‘and’. It does not currently support ‘ne’, ‘gt’, ‘le’, ‘ge’, or ‘not’. Default value is None.
orderby (str) – May be used to sort order by reservation properties. Default value is None.
refresh_summary (str) – To indicate whether to refresh the roll up counts of the reservations group by provisioning states. Default value is None.
selected_state (str) – The selected provisioning state. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Reservation]

Raises

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, filter: Optional[str] = None, orderby: Optional[str] = None, refresh_summary: Optional[str] = None, selected_state: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Reservation][source]¶

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
billing_profile_name (str) – The ID that uniquely identifies a billing profile. Required.
filter (str) – May be used to filter by reservation properties. The filter supports ‘eq’, ‘or’, and ‘and’. It does not currently support ‘ne’, ‘gt’, ‘le’, ‘ge’, or ‘not’. Default value is None.
orderby (str) – May be used to sort order by reservation properties. Default value is None.
refresh_summary (str) – To indicate whether to refresh the roll up counts of the reservations group by provisioning state. Default value is None.
selected_state (str) – The selected provisioning state. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Reservation]

Raises

models = <module 'azure.mgmt.billing.models' from '/mnt/vss/_work/1/s/sdk/billing/azure-mgmt-billing/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/billing/models/__init__.py'>¶

class azure.mgmt.billing.operations.TransactionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through BillingManagementClient’s transactions attribute.

list_by_invoice(billing_account_name: str, invoice_name: str, **kwargs: Any) → Iterable[azure.mgmt.billing.models._models_py3.Transaction][source]¶

Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.

Parameters

billing_account_name (str) – The ID that uniquely identifies a billing account. Required.
invoice_name (str) – The ID that uniquely identifies an invoice. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Transaction]

Raises