Charges Interface
public interface Charges
Resource collection API of Charges.
Method Summary
Modifier and Type | Method and Description |
---|---|
abstract
Charges |
list(String scope)
Lists the charges based for the defined scope. |
abstract
Response<Charges |
listWithResponse(String scope, String startDate, String endDate, String filter, String apply, Context context)
Lists the charges based for the defined scope. |
Method Details
list
public abstract ChargesListResult list(String scope)
Lists the charges based for the defined scope.
Parameters:
scope
- The scope associated with charges operations. This includes
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department
scope, and
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'
for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the
scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing
period at department scope use
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'.
Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'
for billingAccount scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for
billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for
partners.
Returns:
result of listing charge summary.
listWithResponse
public abstract Response
Lists the charges based for the defined scope.
Parameters:
scope
- The scope associated with charges operations. This includes
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department
scope, and
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'
for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the
scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing
period at department scope use
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'.
Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'
for billingAccount scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for
billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for
partners.
startDate
- Start date.
endDate
- End date.
filter
- May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time).
The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or
'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).
apply
- May be used to group charges for billingAccount scope by properties/billingProfileId,
properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by
properties/invoiceSectionId.
context
- The context to associate with this operation.
Returns:
result of listing charge summary.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for