Customers interface

Package:

@azure/arm-billing

Interface representing a Customers.

Methods

get(string, string, string, CustomersGetOptionalParams)	Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
getByBillingAccount(string, string, CustomersGetByBillingAccountOptionalParams)	Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
listByBillingAccount(string, CustomersListByBillingAccountOptionalParams)	Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
listByBillingProfile(string, string, CustomersListByBillingProfileOptionalParams)	Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Method Details

get(string, string, string, CustomersGetOptionalParams)

Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

function get(billingAccountName: string, billingProfileName: string, customerName: string, options?: CustomersGetOptionalParams): Promise<Customer>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

customerName

string

The ID that uniquely identifies a customer.

options

CustomersGetOptionalParams

The options parameters.

Returns

Promise<Customer>

getByBillingAccount(string, string, CustomersGetByBillingAccountOptionalParams)

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

function getByBillingAccount(billingAccountName: string, customerName: string, options?: CustomersGetByBillingAccountOptionalParams): Promise<Customer>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

customerName

string

The ID that uniquely identifies a customer.

options

CustomersGetByBillingAccountOptionalParams

The options parameters.

Returns

Promise<Customer>

listByBillingAccount(string, CustomersListByBillingAccountOptionalParams)

Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

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

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options

CustomersListByBillingAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Customer, Customer[], PageSettings>

listByBillingProfile(string, string, CustomersListByBillingProfileOptionalParams)

Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: CustomersListByBillingProfileOptionalParams): PagedAsyncIterableIterator<Customer, Customer[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

options

CustomersListByBillingProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Customer, Customer[], PageSettings>