Share via


ApiManagementServiceResource.GetReportsByApiAsync Method

Definition

Lists report records by API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi
  • Operation Id: Reports_ListByApi
  • Default Api Version: 2023-03-01-preview
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract> GetReportsByApiAsync (string filter, int? top = default, int? skip = default, string orderBy = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetReportsByApiAsync : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
override this.GetReportsByApiAsync : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
Public Overridable Function GetReportsByApiAsync (filter As String, 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 AsyncPageable(Of ReportRecordContract)

Parameters

filter
String

The filter to apply on the operation.

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

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

Exceptions

filter is null.

Applies to