你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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>