Reports interface

Пакет:

@azure/arm-apimanagement

Интерфейс, представляющий отчеты.

Методы

listByApi(string, string, string, ReportsListByApiOptionalParams)	Выводит список записей отчета по API.
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	Перечисляет записи отчета по географическим регионам.
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	Перечисляет записи отчета по операциям API.
listByProduct(string, string, string, ReportsListByProductOptionalParams)	Выводит список записей отчета по продуктам.
listByRequest(string, string, string, ReportsListByRequestOptionalParams)	Выводит список записей отчета по запросу.
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)	Выводит список записей отчета по подпискам.
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)	Выводит список записей отчета по времени.
listByUser(string, string, string, ReportsListByUserOptionalParams)	Выводит список записей отчета по пользователям.

Сведения о методе

listByApi(string, string, string, ReportsListByApiOptionalParams)

Выводит список записей отчета по API.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

Фильтр, применяемый к операции.

options

ReportsListByApiOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByGeo(string, string, string, ReportsListByGeoOptionalParams)

Перечисляет записи отчета по географическим регионам.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| страна | выбор | | | |
| регион | 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 | | | |
| | пропускная способность | select, orderBy | | |
| cacheHitsCount | select | | | |
| | cacheMissCount | select | | | |
| apiTimeAvg | select | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

options

ReportsListByGeoOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

Перечисляет записи отчета по операциям API.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | | |
| productId | filter | eq | |
| subscriptionId | filter | eq | | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| | callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | | |
callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | |
| пропускная способность | select, orderBy | | | |
cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| | apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | | |

options

ReportsListByOperationOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByProduct(string, string, string, ReportsListByProductOptionalParams)

Выводит список записей отчета по продуктам.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | | |
callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | |
| пропускная способность | select, orderBy | | | |
cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| | apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | | |

options

ReportsListByProductOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByRequest(string, string, string, ReportsListByRequestOptionalParams)

Выводит список записей отчета по запросу.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| apiId | filter | eq | |
| | operationId | filter | eq | |
| productId | filter | eq | | |
| UserId | filter | eq | |
| apiRegion | filter | eq | | |
| subscriptionId | filter | eq | |

options

ReportsListByRequestOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)

Выводит список записей отчета по подпискам.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | | |
callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | | |
| callCountTotal | select, orderBy | | |
| пропускная способность | select, orderBy | | | |
cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| | apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | | |

options

ReportsListBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

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

Выводит список записей отчета по времени.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | фильтр, выберите | 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 | | | |
| | пропускная способность | select, orderBy | | |
| cacheHitsCount | select | | | |
| | cacheMissCount | select | | | |
| apiTimeAvg | select | | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | |

interval

string

По интервалу времени. Интервал должен быть кратным 15 минутам и не может быть равен нулю. Значение должно быть в формате ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Этот код можно использовать для преобразования TimeSpan в допустимую строку интервала: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

options

ReportsListByTimeOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByUser(string, string, string, ReportsListByUserOptionalParams)

Выводит список записей отчета по пользователям.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

filter

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| метка времени | filter | ge, le | |
| displayName | select, orderBy | | |
| UserId | select, filter | 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 | | |
| пропускная способность | select, orderBy | | | |
cacheHitsCount | select | | | |
| cacheMissCount | select | | | |
| | apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | |
| apiTimeMax | select | | | |
| serviceTimeAvg | select | | | |
| serviceTimeMin | select | | | |
| serviceTimeMax | select | | | | |

options

ReportsListByUserOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>