ApiManagementServiceResource.GetReportsByGeo Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Lists report records by geography.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo
- Operation Id: Reports_ListByGeo
- Default Api Version: 2023-03-01-preview
public virtual Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract> GetReportsByGeo (string filter, int? top = default, int? skip = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetReportsByGeo : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
override this.GetReportsByGeo : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
Public Overridable Function GetReportsByGeo (filter As String, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ReportRecordContract)
Parameters
- filter
- String
| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter | ge, le | | </br>| country | select | | | </br>| region | select | | | </br>| zip | 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>.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
A collection of ReportRecordContract that may take multiple service requests to iterate over.
Exceptions
filter
is null.