Products interface
Interface representing a Products.
Methods
| begin |
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. |
| begin |
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. |
| get(string, string, Products |
Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| list |
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. |
| list |
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. |
| list |
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. |
| list |
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. |
| update(string, string, Product |
Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| validate |
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. |
Method Details
beginMove(string, string, MoveProductRequest, ProductsMoveOptionalParams)
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.
function beginMove(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams): Promise<SimplePollerLike<OperationState<Product>, Product>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- productName
-
string
The ID that uniquely identifies a product.
- parameters
- MoveProductRequest
The properties of the product to initiate a transfer.
- options
- ProductsMoveOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Product>, Product>>
beginMoveAndWait(string, string, MoveProductRequest, ProductsMoveOptionalParams)
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.
function beginMoveAndWait(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsMoveOptionalParams): Promise<Product>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- productName
-
string
The ID that uniquely identifies a product.
- parameters
- MoveProductRequest
The properties of the product to initiate a transfer.
- options
- ProductsMoveOptionalParams
The options parameters.
Returns
Promise<Product>
get(string, string, ProductsGetOptionalParams)
Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function get(billingAccountName: string, productName: string, options?: ProductsGetOptionalParams): Promise<Product>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- productName
-
string
The ID that uniquely identifies a product.
- options
- ProductsGetOptionalParams
The options parameters.
Returns
Promise<Product>
listByBillingAccount(string, ProductsListByBillingAccountOptionalParams)
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.
function listByBillingAccount(billingAccountName: string, options?: ProductsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<Product, Product[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
The options parameters.
Returns
listByBillingProfile(string, string, ProductsListByBillingProfileOptionalParams)
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.
function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: ProductsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<Product, Product[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
The options parameters.
Returns
listByCustomer(string, string, ProductsListByCustomerOptionalParams)
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.
function listByCustomer(billingAccountName: string, customerName: string, options?: ProductsListByCustomerOptionalParams): PagedAsyncIterableIterator<Product, Product[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- customerName
-
string
The ID that uniquely identifies a customer.
The options parameters.
Returns
listByInvoiceSection(string, string, string, ProductsListByInvoiceSectionOptionalParams)
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.
function listByInvoiceSection(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: ProductsListByInvoiceSectionOptionalParams): PagedAsyncIterableIterator<Product, Product[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
The options parameters.
Returns
update(string, string, ProductPatch, ProductsUpdateOptionalParams)
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.
function update(billingAccountName: string, productName: string, parameters: ProductPatch, options?: ProductsUpdateOptionalParams): Promise<Product>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- productName
-
string
The ID that uniquely identifies a product.
- parameters
- ProductPatch
A product.
- options
- ProductsUpdateOptionalParams
The options parameters.
Returns
Promise<Product>
validateMoveEligibility(string, string, MoveProductRequest, ProductsValidateMoveEligibilityOptionalParams)
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.
function validateMoveEligibility(billingAccountName: string, productName: string, parameters: MoveProductRequest, options?: ProductsValidateMoveEligibilityOptionalParams): Promise<MoveProductEligibilityResult>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- productName
-
string
The ID that uniquely identifies a product.
- parameters
- MoveProductRequest
The properties of the product to initiate a transfer.
The options parameters.
Returns
Promise<MoveProductEligibilityResult>