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

Api Issue - Create Or Update

为 API 创建新问题,或更新现有问题。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}?api-version=2022-08-01

URI 参数

名称 必需 类型 说明
apiId
path True

string

API 标识符。 在当前API 管理服务实例中必须是唯一的。

issueId
path True

string

问题标识符。 在当前API 管理服务实例中必须是唯一的。

正则表达式模式: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
If-Match

string

实体的 ETag。 创建实体时不需要,但在更新实体时是必需的。

请求正文

名称 必需 类型 说明
properties.description True

string

描述问题的文本。

properties.title True

string

问题标题。

properties.userId True

string

用户的资源标识符创建了问题。

properties.apiId

string

为其创建问题的 API 的资源标识符。

properties.createdDate

string

创建问题的日期和时间。

properties.state

State

问题的状态。

响应

名称 类型 说明
200 OK

IssueContract

已成功更新 Api 问题

标头

ETag: string

201 Created

IssueContract

已成功添加新 API 问题

标头

ETag: string

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementCreateApiIssue

示例请求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc?api-version=2022-08-01

{
  "properties": {
    "title": "New API issue",
    "description": "New API issue description",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "state": "open",
    "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
  }
}

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc",
  "type": "Microsoft.ApiManagement/service/apis/issues",
  "name": "57d2ef278aa04f0ad01d6cdc",
  "properties": {
    "title": "New API issue",
    "description": "New API issue description",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "state": "open",
    "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc",
  "type": "Microsoft.ApiManagement/service/apis/issues",
  "name": "57d2ef278aa04f0ad01d6cdc",
  "properties": {
    "title": "New API issue",
    "description": "New API issue description",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "state": "open",
    "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

IssueContract

颁发合同详细信息。

State

问题的状态。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

IssueContract

颁发合同详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.apiId

string

为其创建问题的 API 的资源标识符。

properties.createdDate

string

创建问题的日期和时间。

properties.description

string

描述问题的文本。

properties.state

State

问题的状态。

properties.title

string

问题标题。

properties.userId

string

用户的资源标识符创建了问题。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

State

问题的状态。

名称 类型 说明
closed

string

问题已结束。

open

string

此问题已打开。

proposed

string

提出此问题。

removed

string

此问题已被删除。

resolved

string

问题现已解决。