SavingsPlans interface

  • Reference
Package:
@azure/arm-billing

Interface representing a SavingsPlans.

Methods

beginUpdateByBillingAccount(string, string, string, SavingsPlanUpdateRequest, SavingsPlansUpdateByBillingAccountOptionalParams)

Update savings plan by billing account.
beginUpdateByBillingAccountAndWait(string, string, string, SavingsPlanUpdateRequest, SavingsPlansUpdateByBillingAccountOptionalParams)

Update savings plan by billing account.
getByBillingAccount(string, string, string, SavingsPlansGetByBillingAccountOptionalParams)

Get savings plan by billing account.
listByBillingAccount(string, SavingsPlansListByBillingAccountOptionalParams)

List savings plans by billing account.
listBySavingsPlanOrder(string, string, SavingsPlansListBySavingsPlanOrderOptionalParams)

List savings plans in an order by billing account.
validateUpdateByBillingAccount(string, string, string, SavingsPlanUpdateValidateRequest, SavingsPlansValidateUpdateByBillingAccountOptionalParams)

Validate savings plan patch by billing account.

Method Details

beginUpdateByBillingAccount(string, string, string, SavingsPlanUpdateRequest, SavingsPlansUpdateByBillingAccountOptionalParams)

Update savings plan by billing account.

function beginUpdateByBillingAccount(billingAccountName: string, savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateRequest, options?: SavingsPlansUpdateByBillingAccountOptionalParams): Promise<SimplePollerLike<OperationState<SavingsPlanModel>, SavingsPlanModel>>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

body
SavingsPlanUpdateRequest

Request body for patching a savings plan order alias

options
SavingsPlansUpdateByBillingAccountOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SavingsPlanModel>, SavingsPlanModel>>

beginUpdateByBillingAccountAndWait(string, string, string, SavingsPlanUpdateRequest, SavingsPlansUpdateByBillingAccountOptionalParams)

Update savings plan by billing account.

function beginUpdateByBillingAccountAndWait(billingAccountName: string, savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateRequest, options?: SavingsPlansUpdateByBillingAccountOptionalParams): Promise<SavingsPlanModel>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

body
SavingsPlanUpdateRequest

Request body for patching a savings plan order alias

options
SavingsPlansUpdateByBillingAccountOptionalParams

The options parameters.

Returns

Promise<SavingsPlanModel>

getByBillingAccount(string, string, string, SavingsPlansGetByBillingAccountOptionalParams)

Get savings plan by billing account.

function getByBillingAccount(billingAccountName: string, savingsPlanOrderId: string, savingsPlanId: string, options?: SavingsPlansGetByBillingAccountOptionalParams): Promise<SavingsPlanModel>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

options
SavingsPlansGetByBillingAccountOptionalParams

The options parameters.

Returns

Promise<SavingsPlanModel>

listByBillingAccount(string, SavingsPlansListByBillingAccountOptionalParams)

List savings plans by billing account.

function listByBillingAccount(billingAccountName: string, options?: SavingsPlansListByBillingAccountOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options
SavingsPlansListByBillingAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

listBySavingsPlanOrder(string, string, SavingsPlansListBySavingsPlanOrderOptionalParams)

List savings plans in an order by billing account.

function listBySavingsPlanOrder(billingAccountName: string, savingsPlanOrderId: string, options?: SavingsPlansListBySavingsPlanOrderOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

savingsPlanOrderId

string

Order ID of the savings plan

options
SavingsPlansListBySavingsPlanOrderOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

validateUpdateByBillingAccount(string, string, string, SavingsPlanUpdateValidateRequest, SavingsPlansValidateUpdateByBillingAccountOptionalParams)

Validate savings plan patch by billing account.

function validateUpdateByBillingAccount(billingAccountName: string, savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateValidateRequest, options?: SavingsPlansValidateUpdateByBillingAccountOptionalParams): Promise<SavingsPlanValidateResponse>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

body
SavingsPlanUpdateValidateRequest

Request body for patching a savings plan order alias

options
SavingsPlansValidateUpdateByBillingAccountOptionalParams

The options parameters.

Returns

Promise<SavingsPlanValidateResponse>