다음을 통해 공유


Api Issue Comment - List By Service

지정된 API와 관련된 문제에 대한 모든 설명을 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
apiId
path True

string

API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.

issueId
path True

string

문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.

regex 패턴: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName
path True

string

API Management 서비스의 이름입니다.

regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

대상 구독의 ID입니다.

api-version
query True

string

이 작업에 사용할 API 버전입니다.

$filter
query

string

| 필드 | 사용량 | 지원되는 연산자 | 지원되는 함수 |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

건너뛸 레코드의 수입니다.

$top
query

integer

int32

반환할 레코드의 수입니다.

응답

Name 형식 Description
200 OK

IssueCommentCollection

페이징된 API에 대한 문제 주석의 결과 응답입니다.

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementListApiIssueComments

샘플 요청

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments?api-version=2022-08-01

샘플 응답

{
  "value": [
    {
      "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb",
      "type": "Microsoft.ApiManagement/service/apis/issues/comments",
      "name": "599e29ab193c3c0bd0b3e2fb",
      "properties": {
        "text": "Issue comment.",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

정의

Name Description
ErrorFieldContract

오류 필드 계약.

ErrorResponse

오류 응답.

IssueCommentCollection

페이징된 문제 주석 목록 표현입니다.

IssueCommentContract

주석 계약 세부 정보를 발급합니다.

ErrorFieldContract

오류 필드 계약.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.

message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

ErrorFieldContract[]

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.

error.message

string

사람이 읽을 수 있는 오류 표현입니다.

IssueCommentCollection

페이징된 문제 주석 목록 표현입니다.

Name 형식 Description
count

integer

모든 페이지의 총 레코드 수 번호입니다.

nextLink

string

다음 페이지 링크(있는 경우).

value

IssueCommentContract[]

주석 값을 발급합니다.

IssueCommentContract

주석 계약 세부 정보를 발급합니다.

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

리소스의 이름입니다.

properties.createdDate

string

주석을 만든 날짜 및 시간입니다.

properties.text

string

주석 텍스트

properties.userId

string

주석을 남긴 사용자의 리소스 식별자입니다.

type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"