Reports interface

Pacote:

@azure/arm-apimanagement

Interface que representa um Relatório.

Métodos

listByApi(string, string, string, ReportsListByApiOptionalParams)	Lista registros de relatório por API.
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	Lista registros de relatório por geografia.
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	Lista registros de relatório por Operações de API.
listByProduct(string, string, string, ReportsListByProductOptionalParams)	Lista registros de relatório por Produto.
listByRequest(string, string, string, ReportsListByRequestOptionalParams)	Lista registros de relatório por Solicitação.
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)	Lista registros de relatório por assinatura.
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)	Lista registros de relatório por hora.
listByUser(string, string, string, ReportsListByUserOptionalParams)	Lista registros de relatório por Usuário.

Detalhes do método

listByApi(string, string, string, ReportsListByApiOptionalParams)

Lista registros de relatório por API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

O filtro a ser aplicado na operação.

options

ReportsListByApiOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByGeo(string, string, string, ReportsListByGeoOptionalParams)

Lista registros de relatório por geografia.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| país | select | | | |
| região | select | | | |
| zip | select | | | |
| apiRegion | filtro | eq | |
| userId | filtro | eq | |
| productId | filtro | eq | |
| subscriptionId | filtro | eq | |
| apiId | filtro | eq | |
| operationId | filtro | eq | |
| callCountSuccess | select | | | |
| callCountBlocked | select | | | |
| callCountFailed | select | | | |
| callCountOther | select | | | |
| largura de banda | select, orderBy | | | |
| cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| apiTimeAvg | select | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListByGeoOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

Lista registros de relatório por Operações de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| apiRegion | filtro | eq | |
| userId | filtro | eq | |
| productId | filtro | eq | |
| subscriptionId | filtro | eq | |
| apiId | filtro | eq | |
| operationId | selecione, filtre | eq | |
| callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | select, orderBy | | | |
| cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| apiTimeAvg | select, orderBy | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListByOperationOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByProduct(string, string, string, ReportsListByProductOptionalParams)

Lista registros de relatório por Produto.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| apiRegion | filtro | eq | |
| userId | filtro | eq | |
| productId | selecione, filtre | eq | |
| subscriptionId | filtro | eq | |
| callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | select, orderBy | | | |
| cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| apiTimeAvg | select, orderBy | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListByProductOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByRequest(string, string, string, ReportsListByRequestOptionalParams)

Lista registros de relatório por Solicitação.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| apiId | filtro | eq | |
| operationId | filtro | eq | |
| productId | filtro | eq | |
| userId | filtro | eq | |
| apiRegion | filtro | eq | |
| subscriptionId | filtro | eq | |

options

ReportsListByRequestOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)

Lista registros de relatório por assinatura.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| apiRegion | filtro | eq | |
| userId | selecione, filtre | eq | |
| productId | selecione, filtre | eq | |
| subscriptionId | selecione, filtre | eq | |
| callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | select, orderBy | | | |
| cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| apiTimeAvg | select, orderBy | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListBySubscriptionOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

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

Lista registros de relatório por hora.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro, selecione | ge, le | |
| intervalo | select | | | |
| apiRegion | filtro | eq | |
| userId | filtro | eq | |
| productId | filtro | eq | |
| subscriptionId | filtro | eq | |
| apiId | filtro | eq | |
| operationId | filtro | eq | |
| callCountSuccess | select | | | |
| callCountBlocked | select | | | |
| callCountFailed | select | | | |
| callCountOther | select | | | |
| largura 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 tempo. O intervalo deve ser múltiplo de 15 minutos e pode não ser zero. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Esse código pode ser usado para converter TimeSpan em uma cadeia de caracteres de intervalo válida: XmlConvert.ToString(new TimeSpan(horas, minutos, segundos)).

options

ReportsListByTimeOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByUser(string, string, string, ReportsListByUserOptionalParams)

Lista registros de relatório por Usuário.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

filter

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| userId | selecione, filtre | eq | |
| apiRegion | filtro | eq | |
| productId | filtro | eq | |
| subscriptionId | filtro | eq | |
| apiId | filtro | eq | |
| operationId | filtro | eq | |
| callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | select, orderBy | | | |
| cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| apiTimeAvg | select, orderBy | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListByUserOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>