ApiManagementServiceResource.GetReportsByTime Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementServiceResource.cs

Lists report records by Time.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime
• Operation Id: Reports_ListByTime
• Default Api Version: 2023-03-01-preview

public virtual Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract> GetReportsByTime (string filter, TimeSpan interval, int? top = default, int? skip = default, string orderBy = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetReportsByTime : string * TimeSpan * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
override this.GetReportsByTime : string * TimeSpan * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>

Public Overridable Function GetReportsByTime (filter As String, interval As TimeSpan, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional orderBy As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ReportRecordContract)

Parameters

filter

String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter, select | ge, le | | </br>| interval | select | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| callCountSuccess | select | | | </br>| callCountBlocked | select | | | </br>| callCountFailed | select | | | </br>| callCountOther | select | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>.

interval

TimeSpan

By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

top

Nullable<Int32>

Number of records to return.

skip

Nullable<Int32>

Number of records to skip.

orderBy

String

OData order by query option.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<ReportRecordContract>

A collection of ReportRecordContract that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

filter is null.