ProductsOperations interface

Package:: @azure/arm-billing

Interface representing a Products operations.

Properties

beginMove
beginMoveAndWait
get	Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
listByBillingAccount	Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
listByBillingProfile	Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
listByCustomer	Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
listByInvoiceSection	Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
move	Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
update	Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
validateMoveEligibility	Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Property Details

beginMove

Warning

This API is now deprecated.

use move instead

beginMove: (billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => Promise<SimplePollerLike<OperationState<Product>, Product>>

Property Value

(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => Promise<SimplePollerLike<OperationState<Product>, Product>>

beginMoveAndWait

Warning

This API is now deprecated.

use move instead

beginMoveAndWait: (billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => Promise<Product>

Property Value

(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => Promise<Product>

get

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

get: (billingAccountName: string, productName: string, options?: ProductsGetOptionalParams) => Promise<Product>

Property Value

(billingAccountName: string, productName: string, options?: ProductsGetOptionalParams) => Promise<Product>

listByBillingAccount

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

listByBillingAccount: (billingAccountName: string, options?: ProductsListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

Property Value

(billingAccountName: string, options?: ProductsListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

listByBillingProfile

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

listByBillingProfile: (billingAccountName: string, billingProfileName: string, options?: ProductsListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, options?: ProductsListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

listByCustomer

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

listByCustomer: (billingAccountName: string, customerName: string, options?: ProductsListByCustomerOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

Property Value

(billingAccountName: string, customerName: string, options?: ProductsListByCustomerOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

listByInvoiceSection

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

listByInvoiceSection: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: ProductsListByInvoiceSectionOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: ProductsListByInvoiceSectionOptionalParams) => PagedAsyncIterableIterator<Product, Product[], PageSettings>

move

Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

move: (billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => PollerLike<OperationState<Product>, Product>

Property Value

(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams) => PollerLike<OperationState<Product>, Product>

update

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

update: (billingAccountName: string, productName: string, parameters: ProductPatch, options?: ProductsUpdateOptionalParams) => Promise<Product>

Property Value

(billingAccountName: string, productName: string, parameters: ProductPatch, options?: ProductsUpdateOptionalParams) => Promise<Product>

validateMoveEligibility

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

validateMoveEligibility: (billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsValidateMoveEligibilityOptionalParams) => Promise<MoveProductEligibilityResult>

Property Value

(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsValidateMoveEligibilityOptionalParams) => Promise<MoveProductEligibilityResult>