Share via

BillingAccountsListOptionalParams interface

  • Reference
Package:
@azure/arm-billing

Optional parameters.

Extends
OperationOptions

Properties

expand

Expand is allowed for SoldTo and EnrollmentDetails/PONumber.
filter

The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
includeAll

When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.
includeAllWithoutBillingProfiles

When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.
includeDeleted

When true, results will include any billing accounts in a deleted state.
includePendingAgreement

Includes billing accounts with agreement pending signature that the user has access to.
includeResellee

Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.
legalOwnerOID

Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.
legalOwnerTID

Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.
search

The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
skip

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top

The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
serializerOptions

Options to override serialization/de-serialization behavior.
tracingOptions

Options used when tracing is enabled.

Property Details

expand

Expand is allowed for SoldTo and EnrollmentDetails/PONumber.

expand?: string

Property Value

string

filter

The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

filter?: string

Property Value

string

includeAll

When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.

includeAll?: boolean

Property Value

boolean

includeAllWithoutBillingProfiles

When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.

includeAllWithoutBillingProfiles?: boolean

Property Value

boolean

includeDeleted

When true, results will include any billing accounts in a deleted state.

includeDeleted?: boolean

Property Value

boolean

includePendingAgreement

Includes billing accounts with agreement pending signature that the user has access to.

includePendingAgreement?: boolean

Property Value

boolean

includeResellee

Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.

includeResellee?: boolean

Property Value

boolean

legalOwnerOID

Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.

legalOwnerOID?: string

Property Value

string

legalOwnerTID

Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.

legalOwnerTID?: string

Property Value

string

The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

search?: string

Property Value

string

skip

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

skip?: number

Property Value

number

top

The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

top?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions