Share via

Agreements interface

  • Reference
Package:
@azure/arm-billing

Interface representing a Agreements.

Methods

get(string, string, AgreementsGetOptionalParams)

Gets an agreement by ID.
listByBillingAccount(string, AgreementsListByBillingAccountOptionalParams)

Lists the agreements for a billing account.

Method Details

get(string, string, AgreementsGetOptionalParams)

Gets an agreement by ID.

function get(billingAccountName: string, agreementName: string, options?: AgreementsGetOptionalParams): Promise<Agreement>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

agreementName

string

The ID that uniquely identifies an agreement.

options
AgreementsGetOptionalParams

The options parameters.

Returns

Promise<Agreement>

listByBillingAccount(string, AgreementsListByBillingAccountOptionalParams)

Lists the agreements for a billing account.

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

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options
AgreementsListByBillingAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Agreement, Agreement[], PageSettings>