Share via


ApiManagementServiceResource.GetReportsByRequestAsync Method

Definition

Lists report records by Request.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest
  • Operation Id: Reports_ListByRequest
  • Default Api Version: 2023-03-01-preview
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.RequestReportRecordContract> GetReportsByRequestAsync (string filter, int? top = default, int? skip = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetReportsByRequestAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.RequestReportRecordContract>
override this.GetReportsByRequestAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.RequestReportRecordContract>
Public Overridable Function GetReportsByRequestAsync (filter As String, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of RequestReportRecordContract)

Parameters

filter
String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter | ge, le | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| productId | filter | eq | | </br>| userId | filter | eq | | </br>| apiRegion | filter | eq | | </br>| subscriptionId | filter | eq | | </br>.

top
Nullable<Int32>

Number of records to return.

skip
Nullable<Int32>

Number of records to skip.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

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

Exceptions

filter is null.

Applies to