azure.mgmt.billing.models module¶

class azure.mgmt.billing.models.AcceptanceMode(value)[source]¶

Bases: str, enum.Enum

The mode of acceptance for an agreement.

CLICK_TO_ACCEPT = 'ClickToAccept'¶

E_SIGN_EMBEDDED = 'ESignEmbedded'¶

E_SIGN_OFFLINE = 'ESignOffline'¶

class azure.mgmt.billing.models.AccountStatus(value)[source]¶

Bases: str, enum.Enum

The current status of the billing account.

ACTIVE = 'Active'¶

DELETED = 'Deleted'¶

DISABLED = 'Disabled'¶

EXPIRED = 'Expired'¶

EXTENDED = 'Extended'¶

TERMINATED = 'Terminated'¶

TRANSFERRED = 'Transferred'¶

class azure.mgmt.billing.models.AccountType(value)[source]¶

Bases: str, enum.Enum

The type of customer.

ENTERPRISE = 'Enterprise'¶

INDIVIDUAL = 'Individual'¶

PARTNER = 'Partner'¶

class azure.mgmt.billing.models.AddressDetails(*, address_line1: str, country: str, first_name: Optional[str] = None, middle_name: Optional[str] = None, last_name: Optional[str] = None, company_name: Optional[str] = None, address_line2: Optional[str] = None, address_line3: Optional[str] = None, city: Optional[str] = None, district: Optional[str] = None, region: Optional[str] = None, postal_code: Optional[str] = None, email: Optional[str] = None, phone_number: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Address details.

All required parameters must be populated in order to send to Azure.

Variables

first_name (str) – First name.
middle_name (str) – Middle name.
last_name (str) – Last name.
company_name (str) – Company name.
address_line1 (str) – Address line 1. Required.
address_line2 (str) – Address line 2.
address_line3 (str) – Address line 3.
city (str) – Address city.
district (str) – Address district.
region (str) – Address region.
country (str) – Country code uses ISO2, 2-digit format. Required.
postal_code (str) – Postal code.
email (str) – Email address.
phone_number (str) – Phone number.

Keyword Arguments

first_name (str) – First name.
middle_name (str) – Middle name.
last_name (str) – Last name.
company_name (str) – Company name.
address_line1 (str) – Address line 1. Required.
address_line2 (str) – Address line 2.
address_line3 (str) – Address line 3.
city (str) – Address city.
district (str) – Address district.
region (str) – Address region.
country (str) – Country code uses ISO2, 2-digit format. Required.
postal_code (str) – Postal code.
email (str) – Email address.
phone_number (str) – Phone number.

class azure.mgmt.billing.models.AddressValidationStatus(value)[source]¶

Bases: str, enum.Enum

Status of the address validation.

INVALID = 'Invalid'¶

VALID = 'Valid'¶

class azure.mgmt.billing.models.Agreement(*, participants: Optional[List[_models.Participants]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An agreement.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
agreement_link (str) – The URL to download the agreement.
category (str or Category) – The category of the agreement signed by a customer. Known values are: “MicrosoftCustomerAgreement”, “AffiliatePurchaseTerms”, and “Other”.
acceptance_mode (str or AcceptanceMode) – The mode of acceptance for an agreement. Known values are: “ClickToAccept”, “ESignEmbedded”, and “ESignOffline”.
billing_profile_info (BillingProfileInfo) – The list of billing profiles associated with agreement and present only for specific agreements.
effective_date (datetime) – The date from which the agreement is effective.
expiration_date (datetime) – The date when the agreement expires.
participants (list[Participants]) – The list of participants that participates in acceptance of an agreement.
status (str) – The current status of the agreement.

Keyword Arguments

participants (list[Participants]) – The list of participants that participates in acceptance of an agreement.

class azure.mgmt.billing.models.AgreementListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of listing agreements.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Agreement]) – The list of agreements.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.AgreementType(value)[source]¶

Bases: str, enum.Enum

The type of agreement.

ENTERPRISE_AGREEMENT = 'EnterpriseAgreement'¶

MICROSOFT_CUSTOMER_AGREEMENT = 'MicrosoftCustomerAgreement'¶

MICROSOFT_ONLINE_SERVICES_PROGRAM = 'MicrosoftOnlineServicesProgram'¶

MICROSOFT_PARTNER_AGREEMENT = 'MicrosoftPartnerAgreement'¶

class azure.mgmt.billing.models.Amount(*, value: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The amount.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

currency (str) – The currency for the amount value.
value (float) – Amount value.

Keyword Arguments

value (float) – Amount value.

class azure.mgmt.billing.models.AutoRenew(value)[source]¶

Bases: str, enum.Enum

Indicates whether auto renewal is turned on or off for a product.

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.billing.models.AvailableBalance(**kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

The latest Azure credit balance. This is the balance available for pay now.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
amount (Amount) – Balance amount.

class azure.mgmt.billing.models.AzurePlan(*, sku_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Details of the Azure plan.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

sku_id (str) – The sku id.
sku_description (str) – The sku description.

Keyword Arguments

sku_id (str) – The sku id.

class azure.mgmt.billing.models.BillingAccount(*, display_name: Optional[str] = None, sold_to: Optional[_models.AddressDetails] = None, billing_profiles: Optional[_models.BillingProfilesOnExpand] = None, departments: Optional[List[_models.Department]] = None, enrollment_accounts: Optional[List[_models.EnrollmentAccount]] = None, notification_email_address: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A billing account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
display_name (str) – The billing account name.
sold_to (AddressDetails) – The address of the individual or organization that is responsible for the billing account.
agreement_type (str or AgreementType) – The type of agreement. Known values are: “MicrosoftCustomerAgreement”, “EnterpriseAgreement”, “MicrosoftOnlineServicesProgram”, and “MicrosoftPartnerAgreement”.
account_type (str or AccountType) – The type of customer. Known values are: “Enterprise”, “Individual”, and “Partner”.
account_status (str or AccountStatus) – The current status of the billing account. Known values are: “Active”, “Deleted”, “Disabled”, “Expired”, “Transferred”, “Extended”, and “Terminated”.
billing_profiles (BillingProfilesOnExpand) – The billing profiles associated with the billing account. By default this is not populated, unless it’s specified in $expand.
enrollment_details (Enrollment) – The details about the associated legacy enrollment. By default this is not populated, unless it’s specified in $expand.
departments (list[Department]) – The departments associated to the enrollment.
enrollment_accounts (list[EnrollmentAccount]) – The accounts associated to the enrollment.
has_read_access (bool) – Indicates whether user has read access to the billing account.
notification_email_address (str) – Notification email address, only for legacy accounts.

Keyword Arguments

display_name (str) – The billing account name.
sold_to (AddressDetails) – The address of the individual or organization that is responsible for the billing account.
billing_profiles (BillingProfilesOnExpand) – The billing profiles associated with the billing account. By default this is not populated, unless it’s specified in $expand.
departments (list[Department]) – The departments associated to the enrollment.
enrollment_accounts (list[EnrollmentAccount]) – The accounts associated to the enrollment.
notification_email_address (str) – Notification email address, only for legacy accounts.

class azure.mgmt.billing.models.BillingAccountListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of billing accounts.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingAccount]) – The list of billing accounts.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingAccountUpdateRequest(*, display_name: Optional[str] = None, sold_to: Optional[_models.AddressDetails] = None, billing_profiles: Optional[_models.BillingProfilesOnExpand] = None, departments: Optional[List[_models.Department]] = None, enrollment_accounts: Optional[List[_models.EnrollmentAccount]] = None, notification_email_address: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The request properties of the billing account that can be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

display_name (str) – The billing account name.
sold_to (AddressDetails) – The address of the individual or organization that is responsible for the billing account.
agreement_type (str or AgreementType) – The type of agreement. Known values are: “MicrosoftCustomerAgreement”, “EnterpriseAgreement”, “MicrosoftOnlineServicesProgram”, and “MicrosoftPartnerAgreement”.
account_type (str or AccountType) – The type of customer. Known values are: “Enterprise”, “Individual”, and “Partner”.
account_status (str or AccountStatus) – The current status of the billing account. Known values are: “Active”, “Deleted”, “Disabled”, “Expired”, “Transferred”, “Extended”, and “Terminated”.
billing_profiles (BillingProfilesOnExpand) – The billing profiles associated with the billing account. By default this is not populated, unless it’s specified in $expand.
enrollment_details (Enrollment) – The details about the associated legacy enrollment. By default this is not populated, unless it’s specified in $expand.
departments (list[Department]) – The departments associated to the enrollment.
enrollment_accounts (list[EnrollmentAccount]) – The accounts associated to the enrollment.
has_read_access (bool) – Indicates whether user has read access to the billing account.
notification_email_address (str) – Notification email address, only for legacy accounts.

Keyword Arguments

display_name (str) – The billing account name.
sold_to (AddressDetails) – The address of the individual or organization that is responsible for the billing account.
billing_profiles (BillingProfilesOnExpand) – The billing profiles associated with the billing account. By default this is not populated, unless it’s specified in $expand.
departments (list[Department]) – The departments associated to the enrollment.
enrollment_accounts (list[EnrollmentAccount]) – The accounts associated to the enrollment.
notification_email_address (str) – Notification email address, only for legacy accounts.

class azure.mgmt.billing.models.BillingFrequency(value)[source]¶

Bases: str, enum.Enum

The frequency at which the product will be billed.

MONTHLY = 'Monthly'¶

ONE_TIME = 'OneTime'¶

USAGE_BASED = 'UsageBased'¶

class azure.mgmt.billing.models.BillingPeriod(**kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A billing period resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
billing_period_start_date (date) – The start of the date range covered by the billing period.
billing_period_end_date (date) – The end of the date range covered by the billing period.
invoice_ids (list[str]) – Array of invoice ids that associated with.

class azure.mgmt.billing.models.BillingPeriodsListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of listing billing periods. It contains a list of available billing periods in reverse chronological order.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingPeriod]) – The list of billing periods.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingPermissionsListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of list billingPermissions a caller has on a billing account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingPermissionsProperties]) – The list of billingPermissions a caller has on a billing account.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingPermissionsProperties(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The set of allowed action and not allowed actions a caller has on a billing account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

actions (list[str]) – The set of actions that the caller is allowed to perform.
not_actions (list[str]) – The set of actions that the caller is not allowed to perform.

class azure.mgmt.billing.models.BillingProfile(*, display_name: Optional[str] = None, po_number: Optional[str] = None, bill_to: Optional[_models.AddressDetails] = None, invoice_email_opt_in: Optional[bool] = None, enabled_azure_plans: Optional[List[_models.AzurePlan]] = None, invoice_sections: Optional[_models.InvoiceSectionsOnExpand] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A billing profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
display_name (str) – The name of the billing profile.
po_number (str) – The purchase order name that will appear on the invoices generated for the billing profile.
billing_relationship_type (str or BillingRelationshipType) – Identifies which services and purchases are paid by a billing profile. Known values are: “Direct”, “IndirectCustomer”, “IndirectPartner”, and “CSPPartner”.
bill_to (AddressDetails) – Billing address.
indirect_relationship_info (IndirectRelationshipInfo) – Identifies the billing profile that is linked to another billing profile in indirect purchase motion.
invoice_email_opt_in (bool) – Flag controlling whether the invoices for the billing profile are sent through email.
invoice_day (int) – The day of the month when the invoice for the billing profile is generated.
currency (str) – The currency in which the charges for the billing profile are billed.
enabled_azure_plans (list[AzurePlan]) – Information about the enabled azure plans.
invoice_sections (InvoiceSectionsOnExpand) – The invoice sections associated to the billing profile. By default this is not populated, unless it’s specified in $expand.
has_read_access (bool) – Indicates whether user has read access to the billing profile.
system_id (str) – The system generated unique identifier for a billing profile.
status (str or BillingProfileStatus) – The status of the billing profile. Known values are: “Active”, “Disabled”, and “Warned”.
status_reason_code (str or StatusReasonCode) – Reason for the specified billing profile status. Known values are: “PastDue”, “SpendingLimitReached”, and “SpendingLimitExpired”.
spending_limit (str or SpendingLimit) – The billing profile spending limit. Known values are: “Off” and “On”.
target_clouds (list[str or TargetCloud]) – Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds.
tags (dict[str, str]) – Tags of billing profiles.

Keyword Arguments

display_name (str) – The name of the billing profile.
po_number (str) – The purchase order name that will appear on the invoices generated for the billing profile.
bill_to (AddressDetails) – Billing address.
invoice_email_opt_in (bool) – Flag controlling whether the invoices for the billing profile are sent through email.
enabled_azure_plans (list[AzurePlan]) – Information about the enabled azure plans.
invoice_sections (InvoiceSectionsOnExpand) – The invoice sections associated to the billing profile. By default this is not populated, unless it’s specified in $expand.
tags (dict[str, str]) – Tags of billing profiles.

class azure.mgmt.billing.models.BillingProfileCreationRequest(*, display_name: Optional[str] = None, po_number: Optional[str] = None, bill_to: Optional[_models.AddressDetails] = None, invoice_email_opt_in: Optional[bool] = None, enabled_azure_plans: Optional[List[_models.AzurePlan]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The request parameters for creating a new billing profile.

Variables

display_name (str) – The name of the billing profile.
po_number (str) – The purchase order name that will appear on the invoices generated for the billing profile.
bill_to (AddressDetails) – The address of the individual or organization that is responsible for the billing profile.
invoice_email_opt_in (bool) – Flag controlling whether the invoices for the billing profile are sent through email.
enabled_azure_plans (list[AzurePlan]) – Enabled azure plans for the billing profile.

Keyword Arguments

display_name (str) – The name of the billing profile.
po_number (str) – The purchase order name that will appear on the invoices generated for the billing profile.
bill_to (AddressDetails) – The address of the individual or organization that is responsible for the billing profile.
invoice_email_opt_in (bool) – Flag controlling whether the invoices for the billing profile are sent through email.
enabled_azure_plans (list[AzurePlan]) – Enabled azure plans for the billing profile.

class azure.mgmt.billing.models.BillingProfileInfo(*, billing_profile_id: Optional[str] = None, billing_profile_display_name: Optional[str] = None, indirect_relationship_organization_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Details about billing profile associated with agreement and available only for specific agreements.

Variables

billing_profile_id (str) – The unique identifier for the billing profile.
billing_profile_display_name (str) – The name of the billing profile.
indirect_relationship_organization_name (str) – Billing account name. This property is available for a specific type of agreement.

Keyword Arguments

billing_profile_id (str) – The unique identifier for the billing profile.
billing_profile_display_name (str) – The name of the billing profile.
indirect_relationship_organization_name (str) – Billing account name. This property is available for a specific type of agreement.

class azure.mgmt.billing.models.BillingProfileListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of billing profiles.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingProfile]) – The list of billing profiles.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingProfileSpendingLimit(value)[source]¶

Bases: str, enum.Enum

The billing profile spending limit.

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.billing.models.BillingProfileStatus(value)[source]¶

Bases: str, enum.Enum

The status of the billing profile.

ACTIVE = 'Active'¶

DISABLED = 'Disabled'¶

WARNED = 'Warned'¶

class azure.mgmt.billing.models.BillingProfileStatusReasonCode(value)[source]¶

Bases: str, enum.Enum

Reason for the specified billing profile status.

PAST_DUE = 'PastDue'¶

SPENDING_LIMIT_EXPIRED = 'SpendingLimitExpired'¶

SPENDING_LIMIT_REACHED = 'SpendingLimitReached'¶

class azure.mgmt.billing.models.BillingProfilesOnExpand(*, value: Optional[List[_models.BillingProfile]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The billing profiles associated with the billing account. By default this is not populated, unless it’s specified in $expand.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

has_more_results (bool) – Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API.
value (list[BillingProfile]) – The billing profiles associated with the billing account.

Keyword Arguments

value (list[BillingProfile]) – The billing profiles associated with the billing account.

class azure.mgmt.billing.models.BillingProperty(*, cost_center: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A billing property.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
account_admin_notification_email_address (str) – The email address on which the account admin gets all Azure notifications.
billing_tenant_id (str) – The Azure AD tenant ID of the billing account for the subscription.
billing_account_id (str) – The ID of the billing account to which the subscription is billed.
billing_account_display_name (str) – The name of the billing account to which the subscription is billed.
billing_profile_id (str) – The ID of the billing profile to which the subscription is billed.
billing_profile_display_name (str) – The name of the billing profile to which the subscription is billed.
billing_profile_status (str or BillingProfileStatus) – The status of the billing profile. Known values are: “Active”, “Disabled”, and “Warned”.
billing_profile_status_reason_code (str or BillingProfileStatusReasonCode) – Reason for the specified billing profile status. Known values are: “PastDue”, “SpendingLimitReached”, and “SpendingLimitExpired”.
billing_profile_spending_limit (str or BillingProfileSpendingLimit) – The billing profile spending limit. Known values are: “Off” and “On”.
cost_center (str) – The cost center applied to the subscription.
invoice_section_id (str) – The ID of the invoice section to which the subscription is billed.
invoice_section_display_name (str) – The name of the invoice section to which the subscription is billed.
is_account_admin (bool) – Indicates whether user is the account admin.
product_id (str) – The product ID of the Azure plan.
product_name (str) – The product name of the Azure plan.
sku_id (str) – The sku ID of the Azure plan for the subscription.
sku_description (str) – The sku description of the Azure plan for the subscription.

Keyword Arguments

cost_center (str) – The cost center applied to the subscription.

class azure.mgmt.billing.models.BillingRelationshipType(value)[source]¶

Bases: str, enum.Enum

Identifies which services and purchases are paid by a billing profile.

CSP_PARTNER = 'CSPPartner'¶

DIRECT = 'Direct'¶

INDIRECT_CUSTOMER = 'IndirectCustomer'¶

INDIRECT_PARTNER = 'IndirectPartner'¶

class azure.mgmt.billing.models.BillingRoleAssignment(*, principal_id: Optional[str] = None, principal_tenant_id: Optional[str] = None, role_definition_id: Optional[str] = None, user_authentication_type: Optional[str] = None, user_email_address: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

The role assignment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
created_on (str) – The date the role assignment was created.
created_by_principal_tenant_id (str) – The tenant Id of the user who created the role assignment.
created_by_principal_id (str) – The principal Id of the user who created the role assignment.
created_by_user_email_address (str) – The email address of the user who created the role assignment.
principal_id (str) – The principal id of the user to whom the role was assigned.
principal_tenant_id (str) – The principal tenant id of the user to whom the role was assigned.
role_definition_id (str) – The ID of the role definition.
scope (str) – The scope at which the role was assigned.
user_authentication_type (str) – The authentication type.
user_email_address (str) – The email address of the user.

Keyword Arguments

principal_id (str) – The principal id of the user to whom the role was assigned.
principal_tenant_id (str) – The principal tenant id of the user to whom the role was assigned.
role_definition_id (str) – The ID of the role definition.
user_authentication_type (str) – The authentication type.
user_email_address (str) – The email address of the user.

class azure.mgmt.billing.models.BillingRoleAssignmentListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of role assignments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingRoleAssignment]) – The list of role assignments.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingRoleDefinition(*, permissions: Optional[List[_models.BillingPermissionsProperties]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

The properties of a role definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
description (str) – The role description.
permissions (list[BillingPermissionsProperties]) – The billingPermissions the role has.
role_name (str) – The name of the role.

Keyword Arguments

permissions (list[BillingPermissionsProperties]) – The billingPermissions the role has.

class azure.mgmt.billing.models.BillingRoleDefinitionListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of role definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingRoleDefinition]) – The role definitions.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.BillingSubscription(*, subscription_billing_status: Optional[Union[str, _models.BillingSubscriptionStatusType]] = None, cost_center: Optional[str] = None, sku_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A billing subscription.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
display_name (str) – The name of the subscription.
subscription_id (str) – The ID of the subscription.
subscription_billing_status (str or BillingSubscriptionStatusType) – The current billing status of the subscription. Known values are: “Active”, “Inactive”, “Abandoned”, “Deleted”, and “Warning”.
last_month_charges (Amount) – The last month charges.
month_to_date_charges (Amount) – The current month to date charges.
billing_profile_id (str) – The ID of the billing profile to which the subscription is billed.
billing_profile_display_name (str) – The name of the billing profile to which the subscription is billed.
cost_center (str) – The cost center applied to the subscription.
customer_id (str) – The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.
customer_display_name (str) – The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.
invoice_section_id (str) – The ID of the invoice section to which the subscription is billed.
invoice_section_display_name (str) – The name of the invoice section to which the subscription is billed.
reseller (Reseller) – Reseller for this subscription.
sku_id (str) – The sku ID of the Azure plan for the subscription.
sku_description (str) – The sku description of the Azure plan for the subscription.
suspension_reasons (list[str]) – The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts.

Keyword Arguments

subscription_billing_status (str or BillingSubscriptionStatusType) – The current billing status of the subscription. Known values are: “Active”, “Inactive”, “Abandoned”, “Deleted”, and “Warning”.
cost_center (str) – The cost center applied to the subscription.
sku_id (str) – The sku ID of the Azure plan for the subscription.

class azure.mgmt.billing.models.BillingSubscriptionStatusType(value)[source]¶

Bases: str, enum.Enum

The current billing status of the subscription.

ABANDONED = 'Abandoned'¶

ACTIVE = 'Active'¶

DELETED = 'Deleted'¶

INACTIVE = 'Inactive'¶

WARNING = 'Warning'¶

class azure.mgmt.billing.models.BillingSubscriptionsListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of billing subscriptions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BillingSubscription]) – The list of billing subscriptions.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.Category(value)[source]¶

Bases: str, enum.Enum

The category of the agreement signed by a customer.

AFFILIATE_PURCHASE_TERMS = 'AffiliatePurchaseTerms'¶

MICROSOFT_CUSTOMER_AGREEMENT = 'MicrosoftCustomerAgreement'¶

OTHER = 'Other'¶

class azure.mgmt.billing.models.Customer(*, display_name: Optional[str] = None, enabled_azure_plans: Optional[List[_models.AzurePlan]] = None, resellers: Optional[List[_models.Reseller]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A partner’s customer.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
billing_profile_id (str) – The ID of the billing profile for the invoice section.
billing_profile_display_name (str) – The name of the billing profile for the invoice section.
display_name (str) – The name of the customer.
enabled_azure_plans (list[AzurePlan]) – Azure plans enabled for the customer.
resellers (list[Reseller]) – The list of resellers for which an Azure plan is enabled for the customer.

Keyword Arguments

display_name (str) – The name of the customer.
enabled_azure_plans (list[AzurePlan]) – Azure plans enabled for the customer.
resellers (list[Reseller]) – The list of resellers for which an Azure plan is enabled for the customer.

class azure.mgmt.billing.models.CustomerListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of customers.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Customer]) – The list of customers.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.CustomerPolicy(*, view_charges: Optional[Union[str, _models.ViewCharges]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

The customer’s Policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
view_charges (str or ViewCharges) – The policy that controls whether the users in customer’s organization can view charges at pay-as-you-go prices. Known values are: “Allowed” and “NotAllowed”.

Keyword Arguments

view_charges (str or ViewCharges) – The policy that controls whether the users in customer’s organization can view charges at pay-as-you-go prices. Known values are: “Allowed” and “NotAllowed”.

class azure.mgmt.billing.models.Department(*, department_name: Optional[str] = None, cost_center: Optional[str] = None, status: Optional[str] = None, enrollment_accounts: Optional[List[_models.EnrollmentAccount]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A department.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
department_name (str) – The name of the department.
cost_center (str) – The cost center associated with the department.
status (str) – The status of the department.
enrollment_accounts (list[EnrollmentAccount]) – Associated enrollment accounts. By default this is not populated, unless it’s specified in $expand.

Keyword Arguments

department_name (str) – The name of the department.
cost_center (str) – The cost center associated with the department.
status (str) – The status of the department.
enrollment_accounts (list[EnrollmentAccount]) – Associated enrollment accounts. By default this is not populated, unless it’s specified in $expand.

class azure.mgmt.billing.models.Document(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The properties of a document.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

kind (str or DocumentType) – The type of the document. Known values are: “Invoice”, “VoidNote”, “TaxReceipt”, and “CreditNote”.
url (str) – Document URL.
source (str or DocumentSource) – The source of the document. ENF for Brazil and DRS for rest of the world. Known values are: “DRS” and “ENF”.

class azure.mgmt.billing.models.DocumentSource(value)[source]¶

Bases: str, enum.Enum

The source of the document. ENF for Brazil and DRS for rest of the world.

DRS = 'DRS'¶

ENF = 'ENF'¶

class azure.mgmt.billing.models.DocumentType(value)[source]¶

Bases: str, enum.Enum

The type of the document.

CREDIT_NOTE = 'CreditNote'¶

INVOICE = 'Invoice'¶

TAX_RECEIPT = 'TaxReceipt'¶

VOID_NOTE = 'VoidNote'¶

class azure.mgmt.billing.models.DownloadUrl(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

A secure URL that can be used to download a an entity until the URL expires.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

expiry_time (datetime) – The time in UTC when the download URL will expire.
url (str) – The URL to the PDF file.

class azure.mgmt.billing.models.Enrollment(*, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The properties of an enrollment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

start_date (datetime) – The start date of the enrollment.
end_date (datetime) – The end date of the enrollment.
currency (str) – The billing currency for the enrollment.
channel (str) – The channel type of the enrollment.
policies (EnrollmentPolicies) – The policies for Enterprise Agreement enrollments.
language (str) – The language for the enrollment.
country_code (str) – The country code of the enrollment.
status (str) – The current status of the enrollment.
billing_cycle (str) – The billing cycle for the enrollment.

Keyword Arguments

start_date (datetime) – The start date of the enrollment.
end_date (datetime) – The end date of the enrollment.

class azure.mgmt.billing.models.EnrollmentAccount(*, account_name: Optional[str] = None, cost_center: Optional[str] = None, account_owner: Optional[str] = None, account_owner_email: Optional[str] = None, status: Optional[str] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, department: Optional[_models.Department] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An enrollment account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
account_name (str) – The name of the enrollment account.
cost_center (str) – The cost center associated with the enrollment account.
account_owner (str) – The owner of the enrollment account.
account_owner_email (str) – The enrollment account owner email address.
status (str) – The status of the enrollment account.
start_date (datetime) – The start date of the enrollment account.
end_date (datetime) – The end date of the enrollment account.
department (Department) – Associated department. By default this is not populated, unless it’s specified in $expand.

Keyword Arguments

account_name (str) – The name of the enrollment account.
cost_center (str) – The cost center associated with the enrollment account.
account_owner (str) – The owner of the enrollment account.
account_owner_email (str) – The enrollment account owner email address.
status (str) – The status of the enrollment account.
start_date (datetime) – The start date of the enrollment account.
end_date (datetime) – The end date of the enrollment account.
department (Department) – Associated department. By default this is not populated, unless it’s specified in $expand.

class azure.mgmt.billing.models.EnrollmentAccountContext(*, cost_center: Optional[str] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, enrollment_account_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The enrollment account context.

Variables

cost_center (str) – The cost center associated with the enrollment account.
start_date (datetime) – The start date of the enrollment account.
end_date (datetime) – The end date of the enrollment account.
enrollment_account_name (str) – The ID of the enrollment account.

Keyword Arguments

cost_center (str) – The cost center associated with the enrollment account.
start_date (datetime) – The start date of the enrollment account.
end_date (datetime) – The end date of the enrollment account.
enrollment_account_name (str) – The ID of the enrollment account.

class azure.mgmt.billing.models.EnrollmentAccountListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of listing enrollment accounts.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[EnrollmentAccountSummary]) – The list of enrollment accounts.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.EnrollmentAccountSummary(**kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An enrollment account resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
principal_name (str) – The account owner’s principal name.

class azure.mgmt.billing.models.EnrollmentPolicies(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The policies for Enterprise Agreement enrollments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

account_owner_view_charges (bool) – The policy that controls whether Account Owners can view charges.
department_admin_view_charges (bool) – The policy that controls whether Department Administrators can view charges.
marketplace_enabled (bool) – The policy that controls whether Azure marketplace purchases are allowed in the enrollment.
reserved_instances_enabled (bool) – The policy that controls whether Azure reservation purchases are allowed in the enrollment.

class azure.mgmt.billing.models.ErrorDetails(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The details of the error.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – Error code.
message (str) – Error message indicating why the operation failed.
target (str) – The target of the particular error.
details (list[ErrorSubDetailsItem]) – The sub details of the error.

class azure.mgmt.billing.models.ErrorResponse(*, error: Optional[_models.ErrorDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Variables: error (ErrorDetails) – The details of the error.
Keyword Arguments: error (ErrorDetails) – The details of the error.

class azure.mgmt.billing.models.ErrorSubDetailsItem(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

ErrorSubDetailsItem.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – Error code.
message (str) – Error message indicating why the operation failed.
target (str) – The target of the particular error.

class azure.mgmt.billing.models.IndirectRelationshipInfo(*, billing_account_name: Optional[str] = None, billing_profile_name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The billing profile details of the partner of the customer for an indirect motion.

Variables

billing_account_name (str) – The billing account name of the partner or the customer for an indirect motion.
billing_profile_name (str) – The billing profile name of the partner or the customer for an indirect motion.
display_name (str) – The display name of the partner or customer for an indirect motion.

Keyword Arguments

billing_account_name (str) – The billing account name of the partner or the customer for an indirect motion.
billing_profile_name (str) – The billing profile name of the partner or the customer for an indirect motion.
display_name (str) – The display name of the partner or customer for an indirect motion.

class azure.mgmt.billing.models.Instruction(*, amount: Optional[float] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, creation_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An instruction.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
amount (float) – The amount budgeted for this billing instruction.
start_date (datetime) – The date this billing instruction goes into effect.
end_date (datetime) – The date this billing instruction is no longer in effect.
creation_date (datetime) – The date this billing instruction was created.

Keyword Arguments

amount (float) – The amount budgeted for this billing instruction.
start_date (datetime) – The date this billing instruction goes into effect.
end_date (datetime) – The date this billing instruction is no longer in effect.
creation_date (datetime) – The date this billing instruction was created.

class azure.mgmt.billing.models.InstructionListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of billing instructions used during invoice generation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Instruction]) – The list of billing instructions used during invoice generation.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.Invoice(**kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An invoice.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
due_date (datetime) – The due date for the invoice.
invoice_date (datetime) – The date when the invoice was generated.
status (str or InvoiceStatus) – The current status of the invoice. Known values are: “Due”, “OverDue”, “Paid”, and “Void”.
amount_due (Amount) – The amount due as of now.
azure_prepayment_applied (Amount) – The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billed_amount (Amount) – The total charges for the invoice billing period.
credit_amount (Amount) – The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
free_azure_credit_applied (Amount) – The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
sub_total (Amount) – The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
tax_amount (Amount) – The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
total_amount (Amount) – The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoice_period_start_date (datetime) – The start date of the billing period for which the invoice is generated.
invoice_period_end_date (datetime) – The end date of the billing period for which the invoice is generated.
invoice_type (str or InvoiceType) – Invoice type. Known values are: “AzureService”, “AzureMarketplace”, and “AzureSupport”.
is_monthly_invoice (bool) – Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billing_profile_id (str) – The ID of the billing profile for which the invoice is generated.
billing_profile_display_name (str) – The name of the billing profile for which the invoice is generated.
purchase_order_number (str) – An optional purchase order number for the invoice.
documents (list[Document]) – List of documents available to download such as invoice and tax receipt.
payments (list[PaymentProperties]) – List of payments.
rebill_details (dict[str, RebillDetails]) – Rebill details for an invoice.
document_type (str or InvoiceDocumentType) – The type of the document. Known values are: “Invoice” and “CreditNote”.
billed_document_id (str) – The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.
credit_for_document_id (str) – The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only.
subscription_id (str) – The ID of the subscription for which the invoice is generated.

class azure.mgmt.billing.models.InvoiceDocumentType(value)[source]¶

Bases: str, enum.Enum

The type of the document.

CREDIT_NOTE = 'CreditNote'¶

INVOICE = 'Invoice'¶

class azure.mgmt.billing.models.InvoiceListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of invoices.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Invoice]) – The list of invoices.
next_link (str) – The link (url) to the next page of results.
total_count (int) – Total number of records.

class azure.mgmt.billing.models.InvoiceSection(*, display_name: Optional[str] = None, labels: Optional[Dict[str, str]] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

An invoice section.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
display_name (str) – The name of the invoice section.
labels (dict[str, str]) – Dictionary of metadata associated with the invoice section.
state (str or InvoiceSectionState) – Identifies the state of an invoice section. Known values are: “Active” and “Restricted”.
system_id (str) – The system generated unique identifier for an invoice section.
tags (dict[str, str]) – Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & ? /.
target_cloud (str or TargetCloud) – Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. Known values are: “USGov”, “USNat”, and “USSec”.

Keyword Arguments

display_name (str) – The name of the invoice section.
labels (dict[str, str]) – Dictionary of metadata associated with the invoice section.
tags (dict[str, str]) – Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & ? /.

class azure.mgmt.billing.models.InvoiceSectionCreationRequest(*, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The properties of the invoice section.

Variables: display_name (str) – The name of the invoice section.
Keyword Arguments: display_name (str) – The name of the invoice section.

class azure.mgmt.billing.models.InvoiceSectionListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of invoice sections.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[InvoiceSection]) – The list of invoice sections.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.InvoiceSectionListWithCreateSubPermissionResult(*, value: Optional[List[_models.InvoiceSectionWithCreateSubPermission]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of invoice section properties with create subscription permission.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[InvoiceSectionWithCreateSubPermission]) – The list of invoice section properties with create subscription permission.
next_link (str) – The link (url) to the next page of results.

Keyword Arguments

value (list[InvoiceSectionWithCreateSubPermission]) – The list of invoice section properties with create subscription permission.

class azure.mgmt.billing.models.InvoiceSectionState(value)[source]¶

Bases: str, enum.Enum

Identifies the state of an invoice section.

ACTIVE = 'Active'¶

RESTRICTED = 'Restricted'¶

class azure.mgmt.billing.models.InvoiceSectionWithCreateSubPermission(*, enabled_azure_plans: Optional[List[_models.AzurePlan]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Invoice section properties with create subscription permission.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

invoice_section_id (str) – The ID of the invoice section.
invoice_section_display_name (str) – The name of the invoice section.
invoice_section_system_id (str) – The system generated unique identifier for an invoice section.
billing_profile_id (str) – The ID of the billing profile for the invoice section.
billing_profile_display_name (str) – The name of the billing profile for the invoice section.
billing_profile_status (str or BillingProfileStatus) – The status of the billing profile. Known values are: “Active”, “Disabled”, and “Warned”.
billing_profile_status_reason_code (str or StatusReasonCodeForBillingProfile) – Reason for the specified billing profile status. Known values are: “PastDue”, “SpendingLimitReached”, and “SpendingLimitExpired”.
billing_profile_spending_limit (str or SpendingLimitForBillingProfile) – The billing profile spending limit. Known values are: “Off” and “On”.
billing_profile_system_id (str) – The system generated unique identifier for a billing profile.
enabled_azure_plans (list[AzurePlan]) – Enabled azure plans for the associated billing profile.

Keyword Arguments

enabled_azure_plans (list[AzurePlan]) – Enabled azure plans for the associated billing profile.

class azure.mgmt.billing.models.InvoiceSectionsOnExpand(*, value: Optional[List[_models.InvoiceSection]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The invoice sections associated to the billing profile. By default this is not populated, unless it’s specified in $expand.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

has_more_results (bool) – Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API.
value (list[InvoiceSection]) – The invoice sections associated to the billing profile.

Keyword Arguments

value (list[InvoiceSection]) – The invoice sections associated to the billing profile.

class azure.mgmt.billing.models.InvoiceStatus(value)[source]¶

Bases: str, enum.Enum

The current status of the invoice.

DUE = 'Due'¶

OVER_DUE = 'OverDue'¶

PAID = 'Paid'¶

VOID = 'Void'¶

class azure.mgmt.billing.models.InvoiceType(value)[source]¶

Bases: str, enum.Enum

Invoice type.

AZURE_MARKETPLACE = 'AzureMarketplace'¶

AZURE_SERVICE = 'AzureService'¶

AZURE_SUPPORT = 'AzureSupport'¶

class azure.mgmt.billing.models.MarketplacePurchasesPolicy(value)[source]¶

Bases: str, enum.Enum

The policy that controls whether Azure marketplace purchases are allowed for a billing profile.

ALL_ALLOWED = 'AllAllowed'¶

NOT_ALLOWED = 'NotAllowed'¶

ONLY_FREE_ALLOWED = 'OnlyFreeAllowed'¶

class azure.mgmt.billing.models.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

A Billing REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Identifies if the operation is a data operation.
display (OperationDisplay) – The object that represents the operation.

Keyword Arguments

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.billing.models.OperationDisplay(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – Service provider: Microsoft.Billing.
resource (str) – Resource on which the operation is performed such as invoice and billing subscription.
operation (str) – Operation type such as read, write and delete.
description (str) – Description of operation.

class azure.mgmt.billing.models.OperationListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of billing operations and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Operation]) – The list of billing operations supported by the Microsoft.Billing resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.billing.models.OperationsErrorDetails(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The details of the error.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – Error code.
message (str) – Error message indicating why the operation failed.
target (str) – The target of the particular error.

class azure.mgmt.billing.models.OperationsErrorResponse(*, error: Optional[_models.OperationsErrorDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Variables: error (OperationsErrorDetails) – The details of the error.
Keyword Arguments: error (OperationsErrorDetails) – The details of the error.

class azure.mgmt.billing.models.Participants(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The details about a participant.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

status (str) – The acceptance status of the participant.
status_date (datetime) – The date when the status got changed.
email (str) – The email address of the participant.

class azure.mgmt.billing.models.PaymentMethodFamily(value)[source]¶

Bases: str, enum.Enum

The family of payment method.

CHECK_WIRE = 'CheckWire'¶

CREDITS = 'Credits'¶

CREDIT_CARD = 'CreditCard'¶

NONE = 'None'¶

class azure.mgmt.billing.models.PaymentProperties(*, payment_method_family: Optional[Union[str, _models.PaymentMethodFamily]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The properties of a payment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

payment_type (str) – The type of payment.
amount (Amount) – The paid amount.
date (datetime) – The date when the payment was made.
payment_method_family (str or PaymentMethodFamily) – The family of payment method. Known values are: “Credits”, “CheckWire”, “CreditCard”, and “None”.
payment_method_type (str) – The type of payment method.

Keyword Arguments

payment_method_family (str or PaymentMethodFamily) – The family of payment method. Known values are: “Credits”, “CheckWire”, “CreditCard”, and “None”.

class azure.mgmt.billing.models.Policy(*, marketplace_purchases: Optional[Union[str, _models.MarketplacePurchasesPolicy]] = None, reservation_purchases: Optional[Union[str, _models.ReservationPurchasesPolicy]] = None, view_charges: Optional[Union[str, _models.ViewChargesPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
marketplace_purchases (str or MarketplacePurchasesPolicy) – The policy that controls whether Azure marketplace purchases are allowed for a billing profile. Known values are: “AllAllowed”, “OnlyFreeAllowed”, and “NotAllowed”.
reservation_purchases (str or ReservationPurchasesPolicy) – The policy that controls whether Azure reservation purchases are allowed for a billing profile. Known values are: “Allowed” and “NotAllowed”.
view_charges (str or ViewChargesPolicy) – The policy that controls whether users with Azure RBAC access to a subscription can view its charges. Known values are: “Allowed” and “NotAllowed”.

Keyword Arguments

marketplace_purchases (str or MarketplacePurchasesPolicy) – The policy that controls whether Azure marketplace purchases are allowed for a billing profile. Known values are: “AllAllowed”, “OnlyFreeAllowed”, and “NotAllowed”.
reservation_purchases (str or ReservationPurchasesPolicy) – The policy that controls whether Azure reservation purchases are allowed for a billing profile. Known values are: “Allowed” and “NotAllowed”.
view_charges (str or ViewChargesPolicy) – The policy that controls whether users with Azure RBAC access to a subscription can view its charges. Known values are: “Allowed” and “NotAllowed”.

class azure.mgmt.billing.models.Product(*, auto_renew: Optional[Union[str, _models.AutoRenew]] = None, status: Optional[Union[str, _models.ProductStatusType]] = None, billing_frequency: Optional[Union[str, _models.BillingFrequency]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A product.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
auto_renew (str or AutoRenew) – Indicates whether auto renewal is turned on or off for a product. Known values are: “Off” and “On”.
display_name (str) – The display name of the product.
purchase_date (datetime) – The date when the product was purchased.
product_type_id (str) – The ID of the type of product.
product_type (str) – The description of the type of product.
status (str or ProductStatusType) – The current status of the product. Known values are: “Active”, “Inactive”, “PastDue”, “Expiring”, “Expired”, “Disabled”, “Cancelled”, and “AutoRenew”.
end_date (datetime) – The date when the product will be renewed or canceled.
billing_frequency (str or BillingFrequency) – The frequency at which the product will be billed. Known values are: “OneTime”, “Monthly”, and “UsageBased”.
last_charge (Amount) – The last month charges.
last_charge_date (datetime) – The date of the last charge.
quantity (float) – The quantity purchased for the product.
sku_id (str) – The sku ID of the product.
sku_description (str) – The sku description of the product.
tenant_id (str) – The id of the tenant in which the product is used.
availability_id (str) – The availability of the product.
invoice_section_id (str) – The ID of the invoice section to which the product is billed.
invoice_section_display_name (str) – The name of the invoice section to which the product is billed.
billing_profile_id (str) – The ID of the billing profile to which the product is billed.
billing_profile_display_name (str) – The name of the billing profile to which the product is billed.
customer_id (str) – The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.
customer_display_name (str) – The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.
reseller (Reseller) – Reseller for this product.

Keyword Arguments

auto_renew (str or AutoRenew) – Indicates whether auto renewal is turned on or off for a product. Known values are: “Off” and “On”.
status (str or ProductStatusType) – The current status of the product. Known values are: “Active”, “Inactive”, “PastDue”, “Expiring”, “Expired”, “Disabled”, “Cancelled”, and “AutoRenew”.
billing_frequency (str or BillingFrequency) – The frequency at which the product will be billed. Known values are: “OneTime”, “Monthly”, and “UsageBased”.

class azure.mgmt.billing.models.ProductStatusType(value)[source]¶

Bases: str, enum.Enum

The current status of the product.

ACTIVE = 'Active'¶

AUTO_RENEW = 'AutoRenew'¶

CANCELLED = 'Cancelled'¶

DISABLED = 'Disabled'¶

EXPIRED = 'Expired'¶

EXPIRING = 'Expiring'¶

INACTIVE = 'Inactive'¶

PAST_DUE = 'PastDue'¶

class azure.mgmt.billing.models.ProductTransferValidationErrorCode(value)[source]¶

Bases: str, enum.Enum

Error code of the transfer validation response.

CROSS_BILLING_ACCOUNT_NOT_ALLOWED = 'CrossBillingAccountNotAllowed'¶

DESTINATION_BILLING_PROFILE_PAST_DUE = 'DestinationBillingProfilePastDue'¶

INSUFFICIENT_PERMISSION_ON_DESTINATION = 'InsufficientPermissionOnDestination'¶

INSUFFICIENT_PERMISSION_ON_SOURCE = 'InsufficientPermissionOnSource'¶

INVALID_SOURCE = 'InvalidSource'¶

NOT_AVAILABLE_FOR_DESTINATION_MARKET = 'NotAvailableForDestinationMarket'¶

ONE_TIME_PURCHASE_PRODUCT_TRANSFER_NOT_ALLOWED = 'OneTimePurchaseProductTransferNotAllowed'¶

PRODUCT_NOT_ACTIVE = 'ProductNotActive'¶

PRODUCT_TYPE_NOT_SUPPORTED = 'ProductTypeNotSupported'¶

class azure.mgmt.billing.models.ProductsListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Product]) – The list of products.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.RebillDetails(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The rebill details of an invoice.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

credit_note_document_id (str) – The ID of credit note.
invoice_document_id (str) – The ID of invoice.
rebill_details (dict[str, RebillDetails]) – Rebill details for an invoice.

class azure.mgmt.billing.models.Reseller(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Details of the reseller.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

reseller_id (str) – The MPN ID of the reseller.
description (str) – The name of the reseller.

class azure.mgmt.billing.models.Reservation(*, sku: Optional[_models.ReservationSkuProperty] = None, applied_scopes: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The definition of the reservation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The id of the reservation.
name (str) – The name of the reservation.
type (str) – The type of the reservation.
location (str) – The location of the reservation.
sku (ReservationSkuProperty) – The sku information associated to this reservation.
applied_scopes (list[str]) – The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.
applied_scope_type (str) – The applied scope type of the reservation.
reserved_resource_type (str) – The reserved source type of the reservation, e.g. virtual machine.
quantity (float) – The number of the reservation.
provisioning_state (str) – The provisioning state of the reservation, e.g. Succeeded.
expiry_date (str) – The expiry date of the reservation.
provisioning_sub_state (str) – The provisioning state of the reservation, e.g. Succeeded.
display_name (str) – The display name of the reservation.
display_provisioning_state (str) – The provisioning state of the reservation for display, e.g. Succeeded.
user_friendly_renew_state (str) – The renew state of the reservation for display, e.g. On.
user_friendly_applied_scope_type (str) – The applied scope type of the reservation for display, e.g. Shared.
effective_date_time (str) – The effective date time of the reservation.
sku_description (str) – The sku description of the reservation.
term (str) – The term of the reservation, e.g. P1Y.
renew (bool) – The renew state of the reservation.
renew_source (str) – The renew source of the reservation.
utilization (ReservationPropertyUtilization) – Reservation utilization.

Keyword Arguments

sku (ReservationSkuProperty) – The sku information associated to this reservation.
applied_scopes (list[str]) – The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.

class azure.mgmt.billing.models.ReservationPropertyUtilization(*, aggregates: Optional[List[_models.ReservationUtilizationAggregates]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Reservation utilization.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

trend (str) – The number of days trend for a reservation.
aggregates (list[ReservationUtilizationAggregates]) – The array of aggregates of a reservation’s utilization.

Keyword Arguments

aggregates (list[ReservationUtilizationAggregates]) – The array of aggregates of a reservation’s utilization.

class azure.mgmt.billing.models.ReservationPurchasesPolicy(value)[source]¶

Bases: str, enum.Enum

The policy that controls whether Azure reservation purchases are allowed for a billing profile.

ALLOWED = 'Allowed'¶

NOT_ALLOWED = 'NotAllowed'¶

class azure.mgmt.billing.models.ReservationSkuProperty(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The property of reservation sku object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: name (str) – The name of the reservation sku.

class azure.mgmt.billing.models.ReservationSummary(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The roll up count summary of reservations in each state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

succeeded_count (float) – The number of reservation in Succeeded state.
failed_count (float) – The number of reservation in Failed state.
expiring_count (float) – The number of reservation in Expiring state.
expired_count (float) – The number of reservation in Expired state.
pending_count (float) – The number of reservation in Pending state.
cancelled_count (float) – The number of reservation in Cancelled state.

class azure.mgmt.billing.models.ReservationType(value)[source]¶

Bases: str, enum.Enum

The type of transaction.

PURCHASE = 'Purchase'¶

USAGE_CHARGE = 'Usage Charge'¶

class azure.mgmt.billing.models.ReservationUtilizationAggregates(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The aggregate values of reservation utilization.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

grain (float) – The grain of the aggregate.
grain_unit (str) – The grain unit of the aggregate.
value (float) – The aggregate value.
value_unit (str) – The aggregate value unit.

class azure.mgmt.billing.models.ReservationsListResult(*, summary: Optional[_models.ReservationSummary] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of reservations and summary of roll out count of reservations in each state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Reservation]) – The list of reservations.
next_link (str) – The link (url) to the next page of results.
summary (ReservationSummary) – The roll out count summary of the reservations.

Keyword Arguments

summary (ReservationSummary) – The roll out count summary of the reservations.

class azure.mgmt.billing.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.billing.models.SpendingLimit(value)[source]¶

Bases: str, enum.Enum

The billing profile spending limit.

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.billing.models.SpendingLimitForBillingProfile(value)[source]¶

Bases: str, enum.Enum

The billing profile spending limit.

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.billing.models.StatusReasonCode(value)[source]¶

Bases: str, enum.Enum

Reason for the specified billing profile status.

PAST_DUE = 'PastDue'¶

SPENDING_LIMIT_EXPIRED = 'SpendingLimitExpired'¶

SPENDING_LIMIT_REACHED = 'SpendingLimitReached'¶

class azure.mgmt.billing.models.StatusReasonCodeForBillingProfile(value)[source]¶

Bases: str, enum.Enum

Reason for the specified billing profile status.

PAST_DUE = 'PastDue'¶

SPENDING_LIMIT_EXPIRED = 'SpendingLimitExpired'¶

SPENDING_LIMIT_REACHED = 'SpendingLimitReached'¶

class azure.mgmt.billing.models.SubscriptionTransferValidationErrorCode(value)[source]¶

Bases: str, enum.Enum

Error code of the transfer validation response.

BILLING_ACCOUNT_INACTIVE = 'BillingAccountInactive'¶

CROSS_BILLING_ACCOUNT_NOT_ALLOWED = 'CrossBillingAccountNotAllowed'¶

DESTINATION_BILLING_PROFILE_INACTIVE = 'DestinationBillingProfileInactive'¶

DESTINATION_BILLING_PROFILE_NOT_FOUND = 'DestinationBillingProfileNotFound'¶

DESTINATION_BILLING_PROFILE_PAST_DUE = 'DestinationBillingProfilePastDue'¶

DESTINATION_INVOICE_SECTION_INACTIVE = 'DestinationInvoiceSectionInactive'¶

DESTINATION_INVOICE_SECTION_NOT_FOUND = 'DestinationInvoiceSectionNotFound'¶

INSUFFICIENT_PERMISSION_ON_DESTINATION = 'InsufficientPermissionOnDestination'¶

INSUFFICIENT_PERMISSION_ON_SOURCE = 'InsufficientPermissionOnSource'¶

INVALID_DESTINATION = 'InvalidDestination'¶

INVALID_SOURCE = 'InvalidSource'¶

MARKETPLACE_NOT_ENABLED_ON_DESTINATION = 'MarketplaceNotEnabledOnDestination'¶

NOT_AVAILABLE_FOR_DESTINATION_MARKET = 'NotAvailableForDestinationMarket'¶

PRODUCT_INACTIVE = 'ProductInactive'¶

PRODUCT_NOT_FOUND = 'ProductNotFound'¶

PRODUCT_TYPE_NOT_SUPPORTED = 'ProductTypeNotSupported'¶

SOURCE_BILLING_PROFILE_PAST_DUE = 'SourceBillingProfilePastDue'¶

SOURCE_INVOICE_SECTION_INACTIVE = 'SourceInvoiceSectionInactive'¶

SUBSCRIPTION_NOT_ACTIVE = 'SubscriptionNotActive'¶

SUBSCRIPTION_TYPE_NOT_SUPPORTED = 'SubscriptionTypeNotSupported'¶

class azure.mgmt.billing.models.TargetCloud(value)[source]¶

Bases: str, enum.Enum

Possible cloud environments.

US_GOV = 'USGov'¶

US_NAT = 'USNat'¶

US_SEC = 'USSec'¶

class azure.mgmt.billing.models.Transaction(*, kind: Optional[Union[str, _models.TransactionTypeKind]] = None, transaction_type: Optional[Union[str, _models.ReservationType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing.models._models_py3.Resource

A transaction.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
kind (str or TransactionTypeKind) – The kind of transaction. Options are all or reservation. Known values are: “all” and “reservation”.
date (datetime) – The date of transaction.
invoice (str) – Invoice on which the transaction was billed or ‘pending’ if the transaction is not billed.
invoice_id (str) – The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.
order_id (str) – The order ID of the reservation. The field is only applicable for transaction of kind reservation.
order_name (str) – The name of the reservation order. The field is only applicable for transactions of kind reservation.
product_family (str) – The family of the product for which the transaction took place.
product_type_id (str) – The ID of the product type for which the transaction took place.
product_type (str) – The type of the product for which the transaction took place.
product_description (str) – The description of the product for which the transaction took place.
transaction_type (str or ReservationType) – The type of transaction. Known values are: “Purchase” and “Usage Charge”.
transaction_amount (Amount) – The charge associated with the transaction.
quantity (int) – The quantity purchased in the transaction.
invoice_section_id (str) – The ID of the invoice section which will be billed for the transaction.
invoice_section_display_name (str) – The name of the invoice section which will be billed for the transaction.
billing_profile_id (str) – The ID of the billing profile which will be billed for the transaction.
billing_profile_display_name (str) – The name of the billing profile which will be billed for the transaction.
customer_id (str) – The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.
customer_display_name (str) – The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.
subscription_id (str) – The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.
subscription_name (str) – The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.
azure_plan (str) – The type of azure plan of the subscription that was used for the transaction.
azure_credit_applied (Amount) – The amount of any Azure credits automatically applied to this transaction.
billing_currency (str) – The ISO 4217 code for the currency in which this transaction is billed.
discount (float) – The percentage discount, if any, applied to this transaction.
effective_price (Amount) – The price of the product after applying any discounts.
exchange_rate (float) – The exchange rate used to convert charged amount to billing currency, if applicable.
market_price (Amount) – The retail price of the product.
pricing_currency (str) – The ISO 4217 code for the currency in which the product is priced.
service_period_start_date (datetime) – The date of the purchase of the product, or the start date of the month in which usage started.
service_period_end_date (datetime) – The end date of the product term, or the end date of the month in which usage ended.
sub_total (Amount) – The pre-tax charged amount for the transaction.
tax (Amount) – The tax amount applied to the transaction.
unit_of_measure (str) – The unit of measure used to bill for the product. For example, compute services are billed per hour.
units (float) – The number of units used for a given product.
unit_type (str) – The description for the unit of measure for a given product.

Keyword Arguments

kind (str or TransactionTypeKind) – The kind of transaction. Options are all or reservation. Known values are: “all” and “reservation”.
transaction_type (str or ReservationType) – The type of transaction. Known values are: “Purchase” and “Usage Charge”.

class azure.mgmt.billing.models.TransactionListResult(**kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The list of transactions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Transaction]) – The list of transactions.
total_count (int) – Total number of records.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.billing.models.TransactionTypeKind(value)[source]¶

Bases: str, enum.Enum

The kind of transaction. Options are all or reservation.

ALL = 'all'¶

RESERVATION = 'reservation'¶

class azure.mgmt.billing.models.TransferBillingSubscriptionRequestProperties(*, destination_invoice_section_id: str, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Request parameters to transfer billing subscription.

All required parameters must be populated in order to send to Azure.

Variables: destination_invoice_section_id (str) – The destination invoice section id. Required.
Keyword Arguments: destination_invoice_section_id (str) – The destination invoice section id. Required.

class azure.mgmt.billing.models.TransferProductRequestProperties(*, destination_invoice_section_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

The properties of the product to initiate a transfer.

Variables: destination_invoice_section_id (str) – The destination invoice section id.
Keyword Arguments: destination_invoice_section_id (str) – The destination invoice section id.

class azure.mgmt.billing.models.ValidateAddressResponse(*, status: Optional[Union[str, _models.AddressValidationStatus]] = None, suggested_addresses: Optional[List[_models.AddressDetails]] = None, validation_message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of the address validation.

Variables

status (str or AddressValidationStatus) – status of the address validation. Known values are: “Valid” and “Invalid”.
suggested_addresses (list[AddressDetails]) – The list of suggested addresses.
validation_message (str) – Validation error message.

Keyword Arguments

status (str or AddressValidationStatus) – status of the address validation. Known values are: “Valid” and “Invalid”.
suggested_addresses (list[AddressDetails]) – The list of suggested addresses.
validation_message (str) – Validation error message.

class azure.mgmt.billing.models.ValidateProductTransferEligibilityError(*, code: Optional[Union[str, _models.ProductTransferValidationErrorCode]] = None, message: Optional[str] = None, details: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Error details of the product transfer eligibility validation.

Variables

code (str or ProductTransferValidationErrorCode) – Error code for the product transfer validation. Known values are: “InvalidSource”, “ProductNotActive”, “InsufficientPermissionOnSource”, “InsufficientPermissionOnDestination”, “DestinationBillingProfilePastDue”, “ProductTypeNotSupported”, “CrossBillingAccountNotAllowed”, “NotAvailableForDestinationMarket”, and “OneTimePurchaseProductTransferNotAllowed”.
message (str) – The error message.
details (str) – Detailed error message explaining the error.

Keyword Arguments

code (str or ProductTransferValidationErrorCode) – Error code for the product transfer validation. Known values are: “InvalidSource”, “ProductNotActive”, “InsufficientPermissionOnSource”, “InsufficientPermissionOnDestination”, “DestinationBillingProfilePastDue”, “ProductTypeNotSupported”, “CrossBillingAccountNotAllowed”, “NotAvailableForDestinationMarket”, and “OneTimePurchaseProductTransferNotAllowed”.
message (str) – The error message.
details (str) – Detailed error message explaining the error.

class azure.mgmt.billing.models.ValidateProductTransferEligibilityResult(*, error_details: Optional[_models.ValidateProductTransferEligibilityError] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of the product transfer eligibility validation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

is_move_eligible (bool) – Specifies whether the transfer is eligible or not.
error_details (ValidateProductTransferEligibilityError) – Validation error details.

Keyword Arguments

error_details (ValidateProductTransferEligibilityError) – Validation error details.

class azure.mgmt.billing.models.ValidateSubscriptionTransferEligibilityError(*, code: Optional[Union[str, _models.SubscriptionTransferValidationErrorCode]] = None, message: Optional[str] = None, details: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Error details of the transfer eligibility validation.

Variables

code (str or SubscriptionTransferValidationErrorCode) – Error code for the product transfer validation. Known values are: “BillingAccountInactive”, “CrossBillingAccountNotAllowed”, “DestinationBillingProfileInactive”, “DestinationBillingProfileNotFound”, “DestinationBillingProfilePastDue”, “DestinationInvoiceSectionInactive”, “DestinationInvoiceSectionNotFound”, “InsufficientPermissionOnDestination”, “InsufficientPermissionOnSource”, “InvalidDestination”, “InvalidSource”, “MarketplaceNotEnabledOnDestination”, “NotAvailableForDestinationMarket”, “ProductInactive”, “ProductNotFound”, “ProductTypeNotSupported”, “SourceBillingProfilePastDue”, “SourceInvoiceSectionInactive”, “SubscriptionNotActive”, and “SubscriptionTypeNotSupported”.
message (str) – The error message.
details (str) – Detailed error message explaining the error.

Keyword Arguments

code (str or SubscriptionTransferValidationErrorCode) – Error code for the product transfer validation. Known values are: “BillingAccountInactive”, “CrossBillingAccountNotAllowed”, “DestinationBillingProfileInactive”, “DestinationBillingProfileNotFound”, “DestinationBillingProfilePastDue”, “DestinationInvoiceSectionInactive”, “DestinationInvoiceSectionNotFound”, “InsufficientPermissionOnDestination”, “InsufficientPermissionOnSource”, “InvalidDestination”, “InvalidSource”, “MarketplaceNotEnabledOnDestination”, “NotAvailableForDestinationMarket”, “ProductInactive”, “ProductNotFound”, “ProductTypeNotSupported”, “SourceBillingProfilePastDue”, “SourceInvoiceSectionInactive”, “SubscriptionNotActive”, and “SubscriptionTypeNotSupported”.
message (str) – The error message.
details (str) – Detailed error message explaining the error.

class azure.mgmt.billing.models.ValidateSubscriptionTransferEligibilityResult(*, error_details: Optional[_models.ValidateSubscriptionTransferEligibilityError] = None, **kwargs)[source]¶

Bases: azure.mgmt.billing._serialization.Model

Result of the transfer eligibility validation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

is_move_eligible (bool) – Specifies whether the subscription is eligible to be transferred.
error_details (ValidateSubscriptionTransferEligibilityError) – Validation error details.

Keyword Arguments

error_details (ValidateSubscriptionTransferEligibilityError) – Validation error details.

class azure.mgmt.billing.models.ViewCharges(value)[source]¶

Bases: str, enum.Enum

The policy that controls whether the users in customer’s organization can view charges at pay-as-you-go prices.

ALLOWED = 'Allowed'¶

NOT_ALLOWED = 'NotAllowed'¶

class azure.mgmt.billing.models.ViewChargesPolicy(value)[source]¶

Bases: str, enum.Enum

The policy that controls whether users with Azure RBAC access to a subscription can view its charges.

ALLOWED = 'Allowed'¶

NOT_ALLOWED = 'NotAllowed'¶