通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Reports Interface

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

Implements

com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ReportsInner>

public interface Reports
extends com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ReportsInner>

Type representing Reports.

Method Summary

Modifier and Type Method and Description
abstract rx.Observable<ReportRecordContract> listByApiAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by API.
abstract rx.Observable<ReportRecordContract> listByGeoAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by geography.
abstract rx.Observable<ReportRecordContract> listByOperationAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by API Operations.
abstract rx.Observable<ReportRecordContract> listByProductAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by Product.
abstract rx.Observable<RequestReportRecordContract> listByRequestAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by Request.
abstract rx.Observable<ReportRecordContract> listBySubscriptionAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by subscription.
abstract rx.Observable<ReportRecordContract> listByTimeAsync(String resourceGroupName, String serviceName, String filter, Period interval)

Lists report records by Time.
abstract rx.Observable<ReportRecordContract> listByUserAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by User.

Method Details

listByApiAsync

public abstract Observable<ReportRecordContract> listByApiAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by API.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - The filter to apply on the operation.

Returns:

the observable for the request

listByGeoAsync

public abstract Observable<ReportRecordContract> listByGeoAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by geography.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | 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>

Returns:

the observable for the request

listByOperationAsync

public abstract Observable<ReportRecordContract> listByOperationAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by API Operations.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | 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>

Returns:

the observable for the request

listByProductAsync

public abstract Observable<ReportRecordContract> listByProductAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by Product.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | select, filter | eq | | </br>| subscriptionId | 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>

Returns:

the observable for the request

listByRequestAsync

public abstract Observable<RequestReportRecordContract> listByRequestAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by Request.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | 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>

Returns:

the observable for the request

listBySubscriptionAsync

public abstract Observable<ReportRecordContract> listBySubscriptionAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by subscription.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | 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>

Returns:

the observable for the request

listByTimeAsync

public abstract Observable<ReportRecordContract> listByTimeAsync(String resourceGroupName, String serviceName, String filter, Period interval)

Lists report records by Time.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | 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 - 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)).

Returns:

the observable for the request

listByUserAsync

public abstract Observable<ReportRecordContract> listByUserAsync(String resourceGroupName, String serviceName, String filter)

Lists report records by User.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| userId | select, filter | eq | | </br>| apiRegion | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | 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>

Returns:

the observable for the request

Applies to