Reports interface

パッケージ:

@azure/arm-apimanagement

レポートを表すインターフェイス。

メソッド

listByApi(string, string, string, ReportsListByApiOptionalParams)	API 別にレポート レコードを一覧表示します。
listByGeo(string, string, string, ReportsListByGeoOptionalParams)	レポート レコードを地域別に一覧表示します。
listByOperation(string, string, string, ReportsListByOperationOptionalParams)	API Operations 別のレポート レコードを一覧表示します。
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 Management サービスの名前。

filter

string

操作に適用するフィルター。

options

ReportsListByApiOptionalParams

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
| country | select | | | |
region |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 | | | |
|bandwidth |select、orderBy | | |
| cacheHitsCount | select | | | |
cacheMissCount |select | | |
| apiTimeAvg | select | | | |
apiTimeMin |select | | |
| apiTimeMax | select | | | |
serviceTimeAvg |select | | |
| serviceTimeMin | select | | | |
serviceTimeMax |select | | |

options

ReportsListByGeoOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>

listByOperation(string, string, string, ReportsListByOperationOptionalParams)

API Operations 別のレポート レコードを一覧表示します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |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 | | |
| bandwidth | select, orderBy | | | |
|cacheHitsCount |select | | |
| cacheMissCount | select | | | |
apiTimeAvg |select、orderBy | | |
| apiTimeMin | select | | | |
apiTimeMax |select | | |
| serviceTimeAvg | select | | | |
serviceTimeMin |select | | |
| serviceTimeMax | select | | |

options

ReportsListByOperationOptionalParams

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |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 | | |
| bandwidth | select, orderBy | | | |
|cacheHitsCount |select | | |
| cacheMissCount | select | | | |
apiTimeAvg |select、orderBy | | |
| apiTimeMin | select | | | |
apiTimeMax |select | | |
| serviceTimeAvg | select | | | |
serviceTimeMin |select | | |
| serviceTimeMax | select | | |

options

ReportsListByProductOptionalParams

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
| apiId | filter | eq | | |
|operationId |filter |eq | |
| productId | filter | eq | | |
|userId |filter |eq | |
| apiRegion | filter | eq | | |
subscriptionId |filter |eq | |

options

ReportsListByRequestOptionalParams

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |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 | | |
| bandwidth | select, orderBy | | | |
|cacheHitsCount |select | | |
| cacheMissCount | select | | | |
apiTimeAvg |select、orderBy | | |
| apiTimeMin | select | | | |
apiTimeMax |select | | |
| serviceTimeAvg | select | | | |
serviceTimeMin |select | | |
| serviceTimeMax | select | | |

options

ReportsListBySubscriptionOptionalParams

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |フィルター、選択 |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 | | | |
|bandwidth |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

options パラメーター。

戻り値

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 Management サービスの名前。

filter

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |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 | | |
| bandwidth | select, orderBy | | | |
|cacheHitsCount |select | | |
| cacheMissCount | select | | | |
apiTimeAvg |select、orderBy | | |
| apiTimeMin | select | | | |
apiTimeMax |select | | |
| serviceTimeAvg | select | | | |
serviceTimeMin |select | | |
| serviceTimeMax | select | | |

options

ReportsListByUserOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>