Reports interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący raporty.

Metody

listByApi(string, string, string, ReportsListByApiOptionalParams)	Wyświetla listę rekordów raportów według interfejsu API.
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	Wyświetla listę rekordów raportów według lokalizacji geograficznej.
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	Wyświetla listę rekordów raportów według operacji interfejsu API.
listByProduct(string, string, string, ReportsListByProductOptionalParams)	Wyświetla listę rekordów raportów według produktu.
listByRequest(string, string, string, ReportsListByRequestOptionalParams)	Wyświetla listę rekordów raportów według żądania.
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)	Wyświetla listę rekordów raportów według subskrypcji.
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)	Wyświetla listę rekordów raportu według czasu.
listByUser(string, string, string, ReportsListByUserOptionalParams)	Wyświetla listę rekordów raportów według użytkownika.

Szczegóły metody

listByApi(string, string, string, ReportsListByApiOptionalParams)

Wyświetla listę rekordów raportów według interfejsu API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

Filtr, który ma być stosowany do operacji.

options

ReportsListByApiOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByGeo(string, string, string, ReportsListByGeoOptionalParams)

Wyświetla listę rekordów raportów według lokalizacji geograficznej.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filter | ge, le | |
| kraj | select | | | |
region | wybierz | | |
| zip | select | | | |
apiRegion | filter | eq | |
| userId | filter | eq | | |
productId | filter | eq | |
| subscriptionId | filter | eq | | |
apiId | filter | eq | |
| operationId | filter | eq | | |
callCountSuccess | wybierz | | |
| callCountBlocked | select | | | |
callCountFailed | wybierz | | |
| callCountOther | select | | | |
przepustowość | select, orderBy | | |
| cacheHitsCount | select | | | |
cacheMissCount | wybierz | | |
| apiTimeAvg | select | | | |
apiTimeMin | wybierz | | |
| apiTimeMax | select | | | | |
serviceTimeAvg | wybierz | | |
| serviceTimeMin | select | | | | |
serviceTimeMax | wybierz | | |

options

ReportsListByGeoOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

Wyświetla listę rekordów raportów według operacji interfejsu API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | 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 | | |
| przepustowość | select, orderBy | | | |
cacheHitsCount | wybierz | | |
| cacheMissCount | select | | | |
apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | | |
apiTimeMax | wybierz | | |
| serviceTimeAvg | select | | | |
serviceTimeMin | wybierz | | |
| serviceTimeMax | select | | |

options

ReportsListByOperationOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByProduct(string, string, string, ReportsListByProductOptionalParams)

Wyświetla listę rekordów raportów według produktu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filter | ge, le | |
| displayName | select, orderBy | | | |
apiRegion | filter | eq | |
| userId | filter | eq | | |
productId | wybieranie, filtrowanie | eq | |
| subscriptionId | filter | eq | | |
callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | | |
callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | | |
callCountTotal | select, orderBy | | |
| przepustowość | select, orderBy | | | |
cacheHitsCount | wybierz | | |
| cacheMissCount | select | | | |
apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | | |
apiTimeMax | wybierz | | |
| serviceTimeAvg | select | | | |
serviceTimeMin | wybierz | | |
| serviceTimeMax | select | | |

options

ReportsListByProductOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByRequest(string, string, string, ReportsListByRequestOptionalParams)

Wyświetla listę rekordów raportów według żądania.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filter | ge, le | |
| apiId | filter | eq | | |
operationId | filter | eq | |
| productId | filter | eq | | |
userId | filter | eq | |
| apiRegion | filter | eq | | |
subscriptionId | filter | eq | |

options

ReportsListByRequestOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>

listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)

Wyświetla listę rekordów raportów według subskrypcji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filter | ge, le | |
| displayName | select, orderBy | | | |
apiRegion | filter | eq | |
| userId | select, filter | eq | | |
productId | wybieranie, filtrowanie | eq | |
| subscriptionId | select, filter | eq | | |
callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | | |
callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | | |
callCountTotal | select, orderBy | | |
| przepustowość | select, orderBy | | | |
cacheHitsCount | wybierz | | |
| cacheMissCount | select | | | |
apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | | |
apiTimeMax | wybierz | | |
| serviceTimeAvg | select | | | |
serviceTimeMin | wybierz | | |
| serviceTimeMax | select | | |

options

ReportsListBySubscriptionOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

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

Wyświetla listę rekordów raportu według czasu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filtruj, wybierz | ge, le | |
| interwał | wybór | | | |
apiRegion | filter | eq | |
| userId | filter | eq | | |
productId | filter | eq | |
| subscriptionId | filter | eq | | |
apiId | filter | eq | |
| operationId | filter | eq | | |
callCountSuccess | wybierz | | |
| callCountBlocked | select | | | |
callCountFailed | wybierz | | |
| callCountOther | select | | | |
przepustowość | select, orderBy | | |
| cacheHitsCount | select | | | |
cacheMissCount | wybierz | | |
| apiTimeAvg | select | | | |
apiTimeMin | wybierz | | |
| apiTimeMax | select | | | | |
serviceTimeAvg | wybierz | | |
| serviceTimeMin | select | | | | |
serviceTimeMax | wybierz | | |

interval

string

Według przedziału czasu. Interwał musi być wielokrotny 15 minut i może nie być równy zero. Wartość powinna być w formacie ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Ten kod może służyć do konwertowania elementu TimeSpan na prawidłowy ciąg interwału: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

options

ReportsListByTimeOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByUser(string, string, string, ReportsListByUserOptionalParams)

Wyświetla listę rekordów raportów według użytkownika.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

filter

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| sygnatura czasowa | filter | ge, le | |
| displayName | select, orderBy | | | |
userId | wybieranie, filtrowanie | 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 | | |
| przepustowość | select, orderBy | | | |
cacheHitsCount | wybierz | | |
| cacheMissCount | select | | | |
apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | | | |
apiTimeMax | wybierz | | |
| serviceTimeAvg | select | | | |
serviceTimeMin | wybierz | | |
| serviceTimeMax | select | | |

options

ReportsListByUserOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>