Share via

SavingsPlan interface

  • Reference
Package:
@azure/arm-billingbenefits

Interface representing a SavingsPlan.

Methods

get(string, string, SavingsPlanGetOptionalParams)

Get savings plan.
list(string, SavingsPlanListOptionalParams)

List savings plans in an order.
listAll(SavingsPlanListAllOptionalParams)

List savings plans.
update(string, string, SavingsPlanUpdateRequest, SavingsPlanUpdateOptionalParams)

Update savings plan.
validateUpdate(string, string, SavingsPlanUpdateValidateRequest, SavingsPlanValidateUpdateOptionalParams)

Validate savings plan patch.

Method Details

get(string, string, SavingsPlanGetOptionalParams)

Get savings plan.

function get(savingsPlanOrderId: string, savingsPlanId: string, options?: SavingsPlanGetOptionalParams): Promise<SavingsPlanModel>

Parameters

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

options
SavingsPlanGetOptionalParams

The options parameters.

Returns

Promise<SavingsPlanModel>

list(string, SavingsPlanListOptionalParams)

List savings plans in an order.

function list(savingsPlanOrderId: string, options?: SavingsPlanListOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

Parameters

savingsPlanOrderId

string

Order ID of the savings plan

options
SavingsPlanListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

listAll(SavingsPlanListAllOptionalParams)

List savings plans.

function listAll(options?: SavingsPlanListAllOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

Parameters

options
SavingsPlanListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>

update(string, string, SavingsPlanUpdateRequest, SavingsPlanUpdateOptionalParams)

Update savings plan.

function update(savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateRequest, options?: SavingsPlanUpdateOptionalParams): Promise<SavingsPlanModel>

Parameters

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
SavingsPlanUpdateOptionalParams

The options parameters.

Returns

Promise<SavingsPlanModel>

validateUpdate(string, string, SavingsPlanUpdateValidateRequest, SavingsPlanValidateUpdateOptionalParams)

Validate savings plan patch.

function validateUpdate(savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateValidateRequest, options?: SavingsPlanValidateUpdateOptionalParams): Promise<SavingsPlanValidateResponse>

Parameters

savingsPlanOrderId

string

Order ID of the savings plan

savingsPlanId

string

ID of the savings plan

body
SavingsPlanUpdateValidateRequest

Request body for validating a savings plan patch request

options
SavingsPlanValidateUpdateOptionalParams

The options parameters.

Returns

Promise<SavingsPlanValidateResponse>