ApiManagementServiceResource.GetReportsBySubscriptionAsync 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 subscription.

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

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

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

Public Overridable Function GetReportsBySubscriptionAsync (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

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

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

AsyncPageable<ReportRecordContract>

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

Exceptions

ArgumentNullException

filter is null.