ApiIssueComment interface
代表 ApiIssueComment 的介面。
方法
| create |
在 API 中為問題建立新的批註，或更新現有的批註。 |
| delete(string, string, string, string, string, string, Api |
從問題中刪除指定的批註。 |
| get(string, string, string, string, string, Api |
取得其識別碼所指定 API 之問題批註的詳細資料。 |
| get |
取得實體狀態 (Etag) 其識別碼所指定 API 的問題批註版本。 |
| 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 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前API 管理服務實例中必須是唯一的。
- issueId
-
string
問題識別碼。 目前API 管理服務實例中必須是唯一的。
- 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 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前API 管理服務實例中必須是唯一的。
- issueId
-
string
問題識別碼。 目前API 管理服務實例中必須是唯一的。
- 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 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前API 管理服務實例中必須是唯一的。
- issueId
-
string
問題識別碼。 目前API 管理服務實例中必須是唯一的。
- commentId
-
string
問題內的批註識別碼。 在目前的問題中必須是唯一的。
- options
- ApiIssueCommentGetOptionalParams
選項參數。
傳回
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
取得實體狀態 (Etag) 其識別碼所指定 API 的問題批註版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前API 管理服務實例中必須是唯一的。
- issueId
-
string
問題識別碼。 目前API 管理服務實例中必須是唯一的。
- 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 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前API 管理服務實例中必須是唯一的。
- issueId
-
string
問題識別碼。 目前API 管理服務實例中必須是唯一的。
選項參數。