Reports interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un informe.

Métodos

listByApi(string, string, string, ReportsListByApiOptionalParams)	Enumera los registros de informe por API.
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	Enumera los registros de informe por geografía.
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	Enumera los registros de informe por operaciones de API.
listByProduct(string, string, string, ReportsListByProductOptionalParams)	Enumera los registros de informe por Producto.
listByRequest(string, string, string, ReportsListByRequestOptionalParams)	Enumera los registros de informe por solicitud.
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)	Enumera los registros de informe por suscripción.
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)	Enumera los registros de informe por hora.
listByUser(string, string, string, ReportsListByUserOptionalParams)	Enumera los registros de informe por usuario.

Detalles del método

listByApi(string, string, string, ReportsListByApiOptionalParams)

Enumera los registros de informe por API.

function listByApi(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByApiOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

Filtro que se va a aplicar en la operación.

options

ReportsListByApiOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByGeo(string, string, string, ReportsListByGeoOptionalParams)

Enumera los registros de informe por geografía.

function listByGeo(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByGeoOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| país | select | | |
| región | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

options

ReportsListByGeoOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

Enumera los registros de informe por operaciones de API.

function listByOperation(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByOperationOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | seleccionar, filtrar | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

options

ReportsListByOperationOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByProduct(string, string, string, ReportsListByProductOptionalParams)

Enumera los registros de informe por Producto.

function listByProduct(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByProductOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | seleccionar, filtrar | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

options

ReportsListByProductOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByRequest(string, string, string, ReportsListByRequestOptionalParams)

Enumera los registros de informe por solicitud.

function listByRequest(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByRequestOptionalParams): PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |

options

ReportsListByRequestOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)

Enumera los registros de informe por suscripción.

function listBySubscription(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | seleccionar, filtrar | eq | |
| productId | seleccionar, filtrar | eq | |
| subscriptionId | seleccionar, filtrar | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

options

ReportsListBySubscriptionOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByTime(string, string, string, string, ReportsListByTimeOptionalParams)

Enumera los registros de informe por hora.

function listByTime(resourceGroupName: string, serviceName: string, filter: string, interval: string, options?: ReportsListByTimeOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filtro, seleccione | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

interval

string

Por intervalo de tiempo. El intervalo debe ser múltiplo de 15 minutos y puede no ser cero. El valor debe estar en formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Este código se puede usar para convertir TimeSpan en una cadena de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

options

ReportsListByTimeOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByUser(string, string, string, ReportsListByUserOptionalParams)

Enumera los registros de informe por usuario.

function listByUser(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByUserOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

filter

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | seleccionar, filtrar | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

options

ReportsListByUserOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>