models Package

Classes

AcceptTransferProperties

Request parameters to accept transfer.

AcceptTransferRequest

Request parameters to accept transfer.

AddressDetails

Address details.

AddressValidationResponse

Result of the address validation.

Agreement

An agreement.

AgreementProperties

An agreement.

Amount

The amount.

AppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

AssociatedTenant

An associated tenant.

AssociatedTenantProperties

An associated tenant.

AvailableBalance

The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.

AvailableBalanceProperties

The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.

AvailableBalancePropertiesAmount

Credit amount for immediate payment.

AvailableBalancePropertiesTotalPaymentsOnAccount

Total amount of payments on accounts.

AzurePlan

Details of the Azure plan.

Beneficiary

Details of the beneficiary.

BillingAccount

A billing account.

BillingAccountPatch

A billing account.

BillingAccountPolicy

A policy at billing account scope.

BillingAccountPolicyProperties

A policy at billing account scope.

BillingAccountPolicyPropertiesEnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

BillingAccountProperties

A billing account.

BillingAccountPropertiesEnrollmentDetails

The properties of an enrollment.

BillingAccountPropertiesRegistrationNumber

Describes the registration number of the organization linked with the billing account.

BillingAccountPropertiesSoldTo

The address of the individual or organization that is responsible for the billing account.

BillingPermission

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

BillingPlanInformation

Information describing the type of billing plan for this savings plan.

BillingProfile

A billing profile.

BillingProfileInfo

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

BillingProfilePolicy

A policy at billing profile scope.

BillingProfilePolicyProperties

A policy at billing profile scope.

BillingProfilePolicyPropertiesEnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

BillingProfileProperties

A billing profile.

BillingProfilePropertiesBillTo

Billing address.

BillingProfilePropertiesCurrentPaymentTerm

The current payment term of the billing profile.

BillingProfilePropertiesIndirectRelationshipInfo

Identifies the billing profile that is linked to another billing profile in indirect purchase motion.

BillingProfilePropertiesShipTo

The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.

BillingProfilePropertiesSoldTo

The address of the individual or organization that is responsible for the billing account.

BillingProperty

A billing property.

BillingPropertyProperties

A billing property.

BillingPropertyPropertiesEnrollmentDetails

The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.

BillingPropertyPropertiesSubscriptionServiceUsageAddress

The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch.

BillingRequest

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

BillingRequestProperties

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

BillingRequestPropertiesCreatedBy

The principal of the entity who created the request.

BillingRequestPropertiesLastUpdatedBy

The principal of the entity who last updated the request.

BillingRequestPropertiesReviewedBy

The principal of the request reviewer. Will only be set if request is approved.

BillingRoleAssignment

The properties of the billing role assignment.

BillingRoleAssignmentListResult

Paged collection of BillingRoleAssignment items.

BillingRoleAssignmentProperties

The properties of the billing role assignment.

BillingRoleDefinition

The properties of a role definition.

BillingRoleDefinitionProperties

The properties of a role definition.

BillingSubscription

The billing properties of a subscription.

BillingSubscriptionAlias

A billing subscription alias.

BillingSubscriptionAliasProperties

A billing subscription alias.

BillingSubscriptionMergeRequest

Request parameters that are provided to merge the two billing subscriptions.

BillingSubscriptionPatch

The billing properties of a subscription.

BillingSubscriptionProperties

The billing properties of a subscription.

BillingSubscriptionSplitRequest

Request parameters that are provided to split the billing subscription.

BillingSubscriptionStatusDetails

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.

CancelSubscriptionRequest

Request parameters for cancel customer subscription.

CheckAccessRequest

Request to check access.

CheckAccessResponse

The properties of a check access response.

Commitment

Commitment towards the benefit.

Customer

A partner's customer.

CustomerPolicy

A policy at customer scope.

CustomerPolicyProperties

A policy at customer scope.

CustomerProperties

A partner's customer.

DeleteBillingProfileEligibilityDetail

Validation details of delete billing profile eligibility.

DeleteBillingProfileEligibilityResult

Eligibility to delete a billing profile result.

DeleteInvoiceSectionEligibilityDetail

The details of delete invoice section eligibility result.

DeleteInvoiceSectionEligibilityResult

Eligibility to delete an invoice section result.

Department

Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.

DepartmentProperties

Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.

DetailedTransferStatus

Detailed transfer status.

DocumentDownloadRequest

A list of download details for individual documents.

DocumentDownloadResult

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

EnrollmentAccount

It is an organizational hierarchy within a billing account to administer and manage azure costs.

EnrollmentAccountProperties

It is an organizational hierarchy within a billing account to administer and manage azure costs.

EnrollmentAccountSubscriptionDetails

The billing properties that can be modified. Available only for the Enterprise Agreement Type.

EnrollmentDetails

The properties of an enrollment.

EnrollmentDetailsIndirectRelationshipInfo

The properties of an enrollment which are applicable only for indirect enrollments.

EnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response.

ExtendedStatusDefinitionProperties

Extended status definition properties.

ExtendedStatusInfo

Extended status information.

ExtendedStatusInfoProperties

Properties specific to credit line check failure.

FailedPayment

A failed payment.

IndirectRelationshipInfo

Identifies the billing profile that is linked to another billing profile in indirect purchase motion.

InitiateTransferProperties

Request parameters to initiate transfer.

InitiateTransferRequest

Request parameters to initiate transfer.

Invoice

An invoice.

InvoiceDocument

The properties of a document.

InvoiceProperties

An invoice.

InvoicePropertiesAmountDue

The amount due as of now.

InvoicePropertiesAzurePrepaymentApplied

The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesBilledAmount

The total charges for the invoice billing period.

InvoicePropertiesCreditAmount

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.

InvoicePropertiesFreeAzureCreditApplied

The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesRebillDetails

Rebill details for an invoice.

InvoicePropertiesRefundDetails

The details of a refund request.

InvoicePropertiesSubTotal

The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesTaxAmount

The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesTotalAmount

The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoiceSection

An invoice section.

InvoiceSectionProperties

An invoice section.

InvoiceSectionWithCreateSubPermission

Invoice section properties with create subscription permission.

MoveBillingSubscriptionEligibilityResult

Result of the transfer eligibility validation.

MoveBillingSubscriptionErrorDetails

Error details of the transfer eligibility validation.

MoveBillingSubscriptionRequest

Request parameters to transfer billing subscription.

MoveProductEligibilityResult

Result of the transfer eligibility validation.

MoveProductEligibilityResultErrorDetails

Error details of the transfer eligibility validation.

MoveProductErrorDetails

Error details of the transfer eligibility validation.

MoveProductRequest

The properties of the product to initiate a transfer.

NextBillingCycleDetails

Billing cycle details of the product.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API.

OperationDisplay

Localized display information for this particular operation.

Participant

Billing account name. Available for a specific type of agreement.

PartnerInitiateTransferProperties

Request parameters to initiate transfer.

PartnerInitiateTransferRequest

Request parameters to initiate partner transfer.

PartnerTransferDetails

Details of the transfer.

PartnerTransferProperties

Transfer Details.

Patch

The request for reservation patch.

PatchProperties

Properties for reservation patch.

PatchPropertiesRenewProperties

PatchPropertiesRenewProperties.

Payment

An invoice payment.

PaymentAmount

The paid amount.

PaymentDetail

Information about payment related to a savings plan order.

PaymentMethod

A payment method.

PaymentMethodLink

A payment method link.

PaymentMethodLinkProperties

The properties of a payment method link.

PaymentMethodLogo

Logo of payment method.

PaymentMethodProperties

The properties of a payment method.

PaymentOnAccount

A Payment on Account.

PaymentOnAccountAmount

Payment on Account amount.

PaymentTerm

The properties of payment term.

PaymentTermsEligibilityDetail

Details of the payment terms eligibility.

PaymentTermsEligibilityResult

Result of the payment terms eligibility.

PolicySummary

The summary of the policy.

Price

The price.

Principal

A principal who has interacted with a billing entity.

Product

A product.

ProductDetails

Details of the product that is transferred.

ProductPatch

A product.

ProductProperties

A product.

ProductPropertiesLastCharge

The last month charges.

ProductPropertiesReseller

Reseller for this product. The fields is not available for Microsoft Partner Agreement products.

ProxyResource

Proxy Resource.

ProxyResourceWithTags

Common fields that are returned in the response for all Azure Resource Manager resources.

PurchaseRequest

Purchase request.

PurchaseRequestProperties

Purchase request properties.

RebillDetails

The rebill details of an invoice.

RecipientTransferDetails

Details of the transfer.

RecipientTransferProperties

Transfer Details.

RefundDetailsSummary

The details of refund request.

RefundDetailsSummaryAmountRefunded

The amount refunded.

RefundDetailsSummaryAmountRequested

The amount of refund requested.

RefundTransactionDetails

The refund details of a transaction.

RefundTransactionDetailsAmountRefunded

The amount refunded.

RefundTransactionDetailsAmountRequested

The amount of refund requested.

RegistrationNumber

Describes the registration number of the organization linked with the billing account.

RenewProperties

Properties specific to renew.

RenewPropertiesResponse

The renew properties for a reservation.

RenewalTermDetails

Details for the next renewal term of a subscription.

Reseller

Details of the reseller.

Reservation

The definition of the reservation.

ReservationAppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup.

ReservationExtendedStatusInfo

Extended status information for the reservation.

ReservationMergeProperties

Properties of reservation merge.

ReservationOrder

Details of a reservation order being returned.

ReservationOrderBillingPlanInformation

Information describing the type of billing plan for this reservation order.

ReservationOrderProperty

Properties of a reservation order.

ReservationPaymentDetail

Information about payment related to a reservation order.

ReservationProperty

The property of reservation object.

ReservationPropertyUtilization

Reservation utilization.

ReservationPurchaseRequest

The request for reservation purchase.

ReservationPurchaseRequestProperties

Properties of reservation purchase request.

ReservationPurchaseRequestPropertiesReservedResourceProperties

Properties specific to each reserved resource type. Not required if not applicable.

ReservationSkuProperty

The property of reservation sku object.

ReservationSplitProperties

Properties of reservation split.

ReservationSummary

The roll up count summary of reservations in each state.

ReservationSwapProperties

Properties of reservation swap.

ReservationUtilizationAggregates

The aggregate values of reservation utilization.

Resource

Resource.

SavingsPlanModel

Savings plan.

SavingsPlanModelProperties

Savings plan properties.

SavingsPlanOrderModel

Savings plan order.

SavingsPlanOrderModelProperties

Savings plan order properties.

SavingsPlanSummaryCount

The roll up count summary of savings plans in each state.

SavingsPlanUpdateRequest

Savings plan patch request.

SavingsPlanUpdateRequestProperties

Savings plan patch request.

SavingsPlanUpdateValidateRequest

Savings plan update validate request.

SavingsPlanValidResponseProperty

Benefit scope response property.

SavingsPlanValidateResponse

Savings plan update validate response.

Sku

The SKU to be applied for this resource.

SkuName

The name of sku.

SpendingLimitDetails

The billing profile spending limit.

SubscriptionEnrollmentDetails

The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.

SubscriptionPolicy

A policy at subscription scope.

SubscriptionPolicyProperties

A policy at subscription scope.

SystemData

Metadata pertaining to creation and last modification of the resource.

SystemOverrides

System imposed policies that regulate behavior of the subscription.

TaxIdentifier

A tax identifier for the billing account.

Transaction

A transaction.

TransactionProperties

A transaction.

TransactionPropertiesAzureCreditApplied

The amount of any Azure credits automatically applied to this transaction.

TransactionPropertiesConsumptionCommitmentDecremented

The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.

TransactionPropertiesEffectivePrice

The price of the product after applying any discounts.

TransactionPropertiesMarketPrice

The retail price of the product.

TransactionPropertiesRefundTransactionDetails

The refund details of a transaction.

TransactionPropertiesSubTotal

The pre-tax charged amount for the transaction.

TransactionPropertiesTax

The tax amount applied to the transaction.

TransactionPropertiesTransactionAmount

The charge associated with the transaction.

TransactionSummary

A transaction summary.

TransferDetails

Details of the transfer.

TransferError

Error details for transfer execution.

TransferProperties

Transfer details.

TransitionDetails

The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

Utilization

Savings plan utilization.

UtilizationAggregates

The aggregate values of savings plan utilization.

ValidateTransferListResponse

Result of transfer validation.

ValidateTransferResponse

Transfer validation response.

ValidateTransferResponseProperties

The properties of transfer validation response.

ValidationResultProperties

The properties of the validation result.

Enums

AcceptanceMode

The mode of acceptance for an agreement.

AccessDecision

Access Decision, specifies access is allowed or not.

AccountStatus

The current status of the billing account.

AccountSubType

The tier of the account.

AccountType

The type of customer.

AddressValidationStatus

Status of the address validation.

AgreementType

The type of agreement.

AppliedScopeType

Type of the Applied Scope.

AutoRenew

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

BillingAccountStatusReasonCode

Reason for the specified billing account status.

BillingManagementTenantState

The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.

BillingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.

BillingProfileStatus

The status of the billing profile.

BillingProfileStatusReasonCode

Reason for the specified billing profile status.

BillingRelationshipType

Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.

BillingRequestStatus

Status of billing request.

BillingRequestType

Type of billing request.

BillingSubscriptionOperationStatus

The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.

BillingSubscriptionStatus

The subscription status.

Cancellation

The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.

CancellationReason

Cancellation reason.

Category

The category of the agreement.

CommitmentGrain

Commitment grain.

CreatedByType

The kind of entity that created the resource.

CreditType

The credit type of the transaction. Applies only to credited transactions.

CustomerStatus

Identifies the status of an customer. This is an upcoming property that will be populated in the future.

DeleteBillingProfileEligibilityCode

Code of the delete invoice section eligibility response.

DeleteBillingProfileEligibilityStatus

Status describing if billing profile is eligible to be deleted.

DeleteInvoiceSectionEligibilityCode

Code for the delete invoice section validation.

DeleteInvoiceSectionEligibilityStatus

Status describing if invoice section is eligible to be deleted.

DocumentSource

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

EligibleProductType

Type of the products that can be transferred.

EnrollmentAccountOwnerViewCharges

The policy that controls whether account owner can view charges.

EnrollmentAuthLevelState

The state showing the enrollment auth level.

EnrollmentDepartmentAdminViewCharges

The policy that controls whether department admin can view charges.

ExtendedTermOption

The billing account extension opted by the company.

FailedPaymentReason

The reason that the payment failed.

InitiatorCustomerType

The type of customer of the transfer initiator.

InstanceFlexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.

InvoiceDocumentType

The type of the document.

InvoiceSectionLabelManagementPolicy

The policy that controls invoice section label management at invoice section scope. This is allowed by default.

InvoiceSectionState

Identifies the status of an invoice section.

InvoiceSectionStateReasonCode

Reason for the specified invoice section status.

InvoiceStatus

The current status of the invoice.

InvoiceType

Invoice type.

MarketplacePurchasesPolicy

The policy that controls whether Azure marketplace purchases are allowed.

MarkupStatus

Markup status of enrollment, applicable only for indirect enrollments.

MoveValidationErrorCode

Error code for the product transfer validation.

PaymentMethodFamily

Payment on Account type.

PaymentMethodStatus

Status of the payment method.

PaymentStatus

Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future.

PaymentTermsEligibilityCode

Indicates the reason for the ineligibility of the payment terms.

PaymentTermsEligibilityStatus

Indicates the eligibility status of the payment terms.

PolicyType

The type of the policy.

PrincipalType

The type of a role Assignment.

ProductStatus

The status of the product.

ProductTransferStatus

The status of a transfer.

ProductType

The type of product that is transferred.

ProvisioningState

The provisioning state of the resource during a long-running operation.

ProvisioningTenantState

The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.

RefundReasonCode

The reason for refund.

RefundStatus

The status of refund request.

ReservationBillingPlan

Represent the billing plans.

ReservationPurchasesPolicy

The policy that controls whether Azure reservation purchases are allowed.

ReservationStatusCode

The status of the reservation.

SavingsPlanPurchasesPolicy

The policy that controls whether users with Azure savings plan purchase are allowed.

SavingsPlanTerm

Represents the Savings plan term in ISO 8601 format.

ServiceDefinedResourceName

Type of ServiceDefinedResourceName.

SpecialTaxationType

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.

SpendingLimit

The billing profile spending limit.

SpendingLimitStatus

The status of current spending limit.

SpendingLimitType

The type of spending limit.

SubscriptionBillingType

The type of billing subscription.

SubscriptionEnrollmentAccountStatus

The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.

SubscriptionStatusReason

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

SubscriptionTransferValidationErrorCode

Error code of the transfer validation response.

SubscriptionWorkloadType

The Azure workload type of the subscription.

SupportLevel

The support level offer associated with an enrollment.

SupportedAccountType

The supported account types.

TaxIdentifierStatus

The status of the tax identifier.

TaxIdentifierType

The type of the tax identifier.

TransactionKind

Type of the transaction, billed or unbilled.

TransactionType

Type of TransactionType.

TransferStatus

The status of a transfer.

ViewChargesPolicy

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