ApiIssueComment interface
ApiIssueComment를 나타내는 인터페이스입니다.
메서드
| create |
API의 문제에 대한 새 설명을 만들거나 기존 설명을 업데이트합니다. |
| delete(string, string, string, string, string, string, Api |
문제에서 지정된 설명을 삭제합니다. |
| get(string, string, string, string, string, Api |
식별자가 지정한 API에 대한 주석 문제에 대한 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 API에 대한 주석 문제의 Etag(엔터티 상태) 버전을 가져옵니다. |
| list |
지정된 API와 관련된 문제에 대한 모든 설명을 나열합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
API의 문제에 대한 새 설명을 만들거나 기존 설명을 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- issueId
-
string
문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- commentId
-
string
문제 내의 주석 식별자입니다. 현재 문제에서 고유해야 합니다.
- parameters
- IssueCommentContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
문제에서 지정된 설명을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- issueId
-
string
문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- commentId
-
string
문제 내의 주석 식별자입니다. 현재 문제에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
식별자가 지정한 API에 대한 주석 문제에 대한 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- issueId
-
string
문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- commentId
-
string
문제 내의 주석 식별자입니다. 현재 문제에서 고유해야 합니다.
- options
- ApiIssueCommentGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
식별자가 지정한 API에 대한 주석 문제의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- issueId
-
string
문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- commentId
-
string
문제 내의 주석 식별자입니다. 현재 문제에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
지정된 API와 관련된 문제에 대한 모든 설명을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- issueId
-
string
문제 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.