ApiIssue interface
表示 ApiIssue 的介面。
方法
| create |
建立 API 的新問題，或更新現有的問題。 |
| delete(string, string, string, string, string, Api |
從 API 刪除指定的問題。 |
| get(string, string, string, string, Api |
取得其識別碼所指定 API 的問題詳細數據。 |
| get |
取得其標識碼所指定 API 的實體狀態 （Etag） 版本。 |
| list |
列出與指定 API 相關聯的所有問題。 |
| update(string, string, string, string, string, Issue |
更新 API 的現有問題。 |
方法詳細資料
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
建立 API 的新問題，或更新現有的問題。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- parameters
- IssueContract
建立參數。
選項參數。
傳回
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
從 API 刪除指定的問題。
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- options
- ApiIssueDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
取得其識別碼所指定 API 的問題詳細數據。
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- options
- ApiIssueGetOptionalParams
選項參數。
傳回
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
取得其標識碼所指定 API 的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<ApiIssueGetEntityTagHeaders>
listByService(string, string, string, ApiIssueListByServiceOptionalParams)
列出與指定 API 相關聯的所有問題。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
更新 API 的現有問題。
function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- IssueUpdateContract
更新參數。
- options
- ApiIssueUpdateOptionalParams
選項參數。
傳回
Promise<ApiIssueUpdateResponse>