ReportsClient Interface

Package:

com.azure.resourcemanager.apimanagement.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface ReportsClient

An instance of this class provides access to all the operations defined in ReportsClient.

Method Summary

Modifier and Type	Method and Description
abstract PagedIterable<ReportRecordContractInner>	listByApi(String resourceGroupName, String serviceName, String filter) Lists report records by API.
abstract PagedIterable<ReportRecordContractInner>	listByApi(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context) Lists report records by API.
abstract PagedIterable<ReportRecordContractInner>	listByGeo(String resourceGroupName, String serviceName, String filter) Lists report records by geography.
abstract PagedIterable<ReportRecordContractInner>	listByGeo(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists report records by geography.
abstract PagedIterable<ReportRecordContractInner>	listByOperation(String resourceGroupName, String serviceName, String filter) Lists report records by API Operations.
abstract PagedIterable<ReportRecordContractInner>	listByOperation(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context) Lists report records by API Operations.
abstract PagedIterable<ReportRecordContractInner>	listByProduct(String resourceGroupName, String serviceName, String filter) Lists report records by Product.
abstract PagedIterable<ReportRecordContractInner>	listByProduct(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context) Lists report records by Product.
abstract PagedIterable<RequestReportRecordContractInner>	listByRequest(String resourceGroupName, String serviceName, String filter) Lists report records by Request.
abstract PagedIterable<RequestReportRecordContractInner>	listByRequest(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists report records by Request.
abstract PagedIterable<ReportRecordContractInner>	listBySubscription(String resourceGroupName, String serviceName, String filter) Lists report records by subscription.
abstract PagedIterable<ReportRecordContractInner>	listBySubscription(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context) Lists report records by subscription.
abstract PagedIterable<ReportRecordContractInner>	listByTime(String resourceGroupName, String serviceName, String filter, Duration interval) Lists report records by Time.
abstract PagedIterable<ReportRecordContractInner>	listByTime(String resourceGroupName, String serviceName, String filter, Duration interval, Integer top, Integer skip, String orderby, Context context) Lists report records by Time.
abstract PagedIterable<ReportRecordContractInner>	listByUser(String resourceGroupName, String serviceName, String filter) Lists report records by User.
abstract PagedIterable<ReportRecordContractInner>	listByUser(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context) Lists report records by User.

Method Details

listByApi

public abstract PagedIterable listByApi(String resourceGroupName, String serviceName, String filter)

Lists report records by API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

filter - The filter to apply on the operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByApi

public abstract PagedIterable listByApi(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context)

Lists report records by API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

filter - The filter to apply on the operation.

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByGeo

public abstract PagedIterable listByGeo(String resourceGroupName, String serviceName, String filter)

Lists report records by geography.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByGeo

public abstract PagedIterable listByGeo(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists report records by geography.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByOperation

public abstract PagedIterable listByOperation(String resourceGroupName, String serviceName, String filter)

Lists report records by API Operations.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByOperation

public abstract PagedIterable listByOperation(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context)

Lists report records by API Operations.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByProduct

public abstract PagedIterable listByProduct(String resourceGroupName, String serviceName, String filter)

Lists report records by Product.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByProduct

public abstract PagedIterable listByProduct(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context)

Lists report records by Product.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByRequest

public abstract PagedIterable listByRequest(String resourceGroupName, String serviceName, String filter)

Lists report records by Request.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByRequest

public abstract PagedIterable listByRequest(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists report records by Request.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listBySubscription

public abstract PagedIterable listBySubscription(String resourceGroupName, String serviceName, String filter)

Lists report records by subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listBySubscription

public abstract PagedIterable listBySubscription(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context)

Lists report records by subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByTime

public abstract PagedIterable listByTime(String resourceGroupName, String serviceName, String filter, Duration interval)

Lists report records by Time.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByTime

public abstract PagedIterable listByTime(String resourceGroupName, String serviceName, String filter, Duration interval, Integer top, Integer skip, String orderby, Context context)

Lists report records by Time.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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)).

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.

listByUser

public abstract PagedIterable listByUser(String resourceGroupName, String serviceName, String filter)

Lists report records by User.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Report records list representation as paginated response with PagedIterable<T>.

listByUser

public abstract PagedIterable listByUser(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, String orderby, Context context)

Lists report records by User.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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>.

top - Number of records to return.

skip - Number of records to skip.

orderby - OData order by query option.

context - The context to associate with this operation.

Returns:

paged Report records list representation as paginated response with PagedIterable<T>.