ApiIssueAttachment interface
表示 ApiIssueAttachment 的介面。
方法
| 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, IssueAttachmentContract, ApiIssueAttachmentCreateOrUpdateOptionalParams)
在 API 中建立問題的新附件，或更新現有的附件。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, parameters: IssueAttachmentContract, options?: ApiIssueAttachmentCreateOrUpdateOptionalParams): Promise<ApiIssueAttachmentCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- attachmentId
-
string
問題內的附件標識碼。 目前問題中必須是唯一的。
- parameters
- IssueAttachmentContract
建立參數。
選項參數。
傳回
delete(string, string, string, string, string, string, ApiIssueAttachmentDeleteOptionalParams)
從問題中刪除指定的批注。
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, ifMatch: string, options?: ApiIssueAttachmentDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- attachmentId
-
string
問題內的附件標識碼。 目前問題中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, string, string, ApiIssueAttachmentGetOptionalParams)
取得其標識碼所指定 API 的問題附件詳細數據。
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetOptionalParams): Promise<ApiIssueAttachmentGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- attachmentId
-
string
問題內的附件標識碼。 目前問題中必須是唯一的。
選項參數。
傳回
Promise<ApiIssueAttachmentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueAttachmentGetEntityTagOptionalParams)
取得其標識碼所指定 API 之問題附件的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetEntityTagOptionalParams): Promise<ApiIssueAttachmentGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
- attachmentId
-
string
問題內的附件標識碼。 目前問題中必須是唯一的。
選項參數。
傳回
listByService(string, string, string, string, ApiIssueAttachmentListByServiceOptionalParams)
列出與指定 API 相關聯之問題的所有附件。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueAttachmentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueAttachmentContract, IssueAttachmentContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 目前 API 管理服務實例中必須是唯一的。
- issueId
-
string
問題標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。