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 Management 서비스의 이름입니다.

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 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 | | |
| 대역폭 | 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 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 | | |
| 대역폭 | 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 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 | | |
| 대역폭 | 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 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

옵션 매개 변수입니다.

반환

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 | | |
| 대역폭 | 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 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 | | |
| 대역폭 | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

interval

string

시간 간격을 기준으로 합니다. 간격은 15분의 배수여야 하며 0이 아닐 수 있습니다. 값은 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 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 | | |
| 대역폭 | 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>