Reports interface

Pacote:

@azure/arm-apimanagement

Interface que representa um Relatório.

Métodos

listByApi(string, string, string, ReportsListByApiOptionalParams)	Lista registos de relatórios por API.
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	Lista registos de relatórios por geografia.
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	Lista registos de relatórios por Operações de API.
listByProduct(string, string, string, ReportsListByProductOptionalParams)	Lista registos de relatórios por Produto.
listByRequest(string, string, string, ReportsListByRequestOptionalParams)	Lista registos de relatórios por Pedido.
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)	Lista registos de relatórios por subscrição.
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)	Lista registos de relatórios por Hora.
listByUser(string, string, string, ReportsListByUserOptionalParams)	Lista registos de relatórios por Utilizador.

Detalhes de Método

listByApi(string, string, string, ReportsListByApiOptionalParams)

Lista registos de relatórios 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

O filtro a aplicar na operação.

options

ReportsListByApiOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByGeo(string, string, string, ReportsListByGeoOptionalParams)

Lista registos de relatórios 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

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

options

ReportsListByGeoOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

Lista registos de relatórios 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| apiRegion | filtro | eq | |
| userId | filter | eq | |
| | productId | filtro | eq | |
| subscriptionId | filter | 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 | selecione, orderBy | | |
| | cacheHitsCount | selecione | | |
| cacheMissCount | selecione | | |
| | apiTimeAvg | select, orderBy | | | |
| apiTimeMin | selecione | | |
| apiTimeMax | selecione | | |
| serviceTimeAvg | selecione | | |
| | serviceTimeMin | selecione | | |
| serviceTimeMax | selecione | | | |

options

ReportsListByOperationOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByProduct(string, string, string, ReportsListByProductOptionalParams)

Lista registos de relatórios 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| apiRegion | filtro | eq | |
| userId | filter | eq | |
| | productId | selecionar, filtrar | eq | |
| subscriptionId | filter | eq | |
| | callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | selecione, orderBy | | |
| | cacheHitsCount | selecione | | |
| cacheMissCount | selecione | | |
| | apiTimeAvg | select, orderBy | | | |
| apiTimeMin | selecione | | |
| apiTimeMax | selecione | | |
| serviceTimeAvg | selecione | | |
| | serviceTimeMin | selecione | | |
| serviceTimeMax | selecione | | | |

options

ReportsListByProductOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByRequest(string, string, string, ReportsListByRequestOptionalParams)

Lista registos de relatórios por Pedido.

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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| apiId | filter | eq | |
| | operationId | filtro | eq | |
| productId | filter | eq | |
| | userId | filtro | eq | |
| apiRegion | filter | eq | |
| | subscriptionId | filtro | eq | |

options

ReportsListByRequestOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)

Lista registos de relatórios por subscrição.

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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

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

options

ReportsListBySubscriptionOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

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

Lista registos de relatórios 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtrar, selecione | ge, le | |
| intervalo | selecione | | |
| | apiRegion | filtro | eq | |
| userId | filter | eq | |
| | productId | filtro | eq | |
| subscriptionId | filter | eq | |
| | apiId | filtro | eq | |
| operationId | filter | eq | |
| | callCountSuccess | selecione | | |
| callCountBlocked | selecione | | |
| | callCountFailed | selecione | | |
| callCountOther | selecione | | |
| | largura de banda | select, orderBy | | | |
| cacheHitsCount | selecione | | |
| | cacheMissCount | selecione | | |
| apiTimeAvg | selecione | | |
| | apiTimeMin | selecione | | |
| apiTimeMax | selecione | | |
| | serviceTimeAvg | selecione | | |
| serviceTimeMin | selecione | | |
| | serviceTimeMax | selecione | | |

interval

string

Por intervalo de tempo. O intervalo tem de 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). Este código pode ser utilizado para converter TimeSpan numa cadeia de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

options

ReportsListByTimeOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByUser(string, string, string, ReportsListByUserOptionalParams)

Lista registos de relatórios por Utilizador.

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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

filter

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| carimbo de data/hora | filtro | ge, le | |
| displayName | select, orderBy | | | |
| userId | selecionar, filtrar | eq | |
| apiRegion | filter | eq | |
| | productId | filtro | eq | |
| subscriptionId | filter | eq | |
| | apiId | filtro | eq | |
| operationId | filter | eq | |
| | callCountSuccess | select, orderBy | | | |
| callCountBlocked | select, orderBy | | | |
| callCountFailed | select, orderBy | | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | | |
| largura de banda | selecione, orderBy | | |
| | cacheHitsCount | selecione | | |
| cacheMissCount | selecione | | |
| | apiTimeAvg | select, orderBy | | | |
| apiTimeMin | selecione | | |
| apiTimeMax | selecione | | |
| serviceTimeAvg | selecione | | |
| | serviceTimeMin | selecione | | |
| serviceTimeMax | selecione | | | |

options

ReportsListByUserOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>