UsageDetailsOperationsExtensions.ListByBillingPeriodAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Consumption

Assembly:

Microsoft.Azure.Management.Consumption.dll

Package:

Microsoft.Azure.Management.Consumption v3.0.2

Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later. https://docs.microsoft.com/en-us/rest/api/consumption/

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.Consumption.Models.UsageDetail>> ListByBillingPeriodAsync (this Microsoft.Azure.Management.Consumption.IUsageDetailsOperations operations, string billingPeriodName, string expand = default, string filter = default, string skiptoken = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member ListByBillingPeriodAsync : Microsoft.Azure.Management.Consumption.IUsageDetailsOperations * string * string * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.Consumption.Models.UsageDetail>>

<Extension()>
Public Function ListByBillingPeriodAsync (operations As IUsageDetailsOperations, billingPeriodName As String, Optional expand As String = Nothing, Optional filter As String = Nothing, Optional skiptoken As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of UsageDetail))

Parameters

operations

IUsageDetailsOperations

The operations group for this extension method.

billingPeriodName

String

Billing Period Name.

expand

String

May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.

filter

String

May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.

skiptoken

String

Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

top

Nullable<Int32>

May be used to limit the number of results to the most recent N usageDetails.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IPage<UsageDetail>>