共用方式為


Api Issue Comment - Create Or Update

為 API 中的問題建立新的批注,或更新現有的批注。

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

URI 參數

名稱 位於 必要 類型 Description
apiId
path True

string

API 識別碼。 在目前 API 管理 服務實例中必須是唯一的。

commentId
path True

string

問題內的批註標識碼。 目前的問題中必須是唯一的。

Regex 模式: ^[^*#&+:<>?]+$

issueId
path True

string

問題標識碼。 在目前 API 管理 服務實例中必須是唯一的。

Regex 模式: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

資源群組的名稱。

serviceName
path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

要與用戶端要求搭配使用的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match

string

實體的 ETag。 建立實體時不需要,但在更新實體時則為必要專案。

要求本文

名稱 必要 類型 Description
properties.text True

string

註解文字。

properties.userId True

string

離開批注之用戶的資源標識碼。

properties.createdDate

string

建立批注的日期和時間。

回應

名稱 類型 Description
200 OK

IssueCommentContract

API 問題批注已成功更新

標題

ETag: string

201 Created

IssueCommentContract

已成功新增 API 問題批注

標題

ETag: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementCreateApiIssueComment

範例要求

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

{
  "properties": {
    "text": "Issue comment.",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "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/comments/599e29ab193c3c0bd0b3e2fb",
  "type": "Microsoft.ApiManagement/service/apis/issues/comments",
  "name": "599e29ab193c3c0bd0b3e2fb",
  "properties": {
    "text": "Issue comment.",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "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/comments/599e29ab193c3c0bd0b3e2fb",
  "type": "Microsoft.ApiManagement/service/apis/issues/comments",
  "name": "599e29ab193c3c0bd0b3e2fb",
  "properties": {
    "text": "Issue comment.",
    "createdDate": "2018-02-01T22:21:20.467Z",
    "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
  }
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

IssueCommentContract

問題批注合約詳細數據。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單,以防發生驗證錯誤。

error.message

string

人類可閱讀的錯誤表示法。

IssueCommentContract

問題批注合約詳細數據。

名稱 類型 Description
id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

資源的名稱

properties.createdDate

string

建立批注的日期和時間。

properties.text

string

註解文字。

properties.userId

string

離開批注之用戶的資源標識碼。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”