你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiIssueAttachment interface
表示 ApiIssueAttachment 的接口。
方法
| 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, 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 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
选项参数。
返回
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)
获取实体状态 (Etag) 由其标识符指定的 API 的附件问题版本。
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 管理服务实例中必须是唯一的。
选项参数。