Api Wiki - Update

服务:

API Management

API 版本:

2024-05-01

更新由其标识符指定的 API 的 Wiki 的详细信息。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
apiId	path	True	string minLength: 1 maxLength: 80	API 标识符。 当前 API 管理服务实例中必须是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
If-Match	True	string	实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

请求正文

名称	类型	说明
properties.documents	WikiDocumentationContract[]	此 Wiki 中包含的集合 Wiki 文档。

响应

名称	类型	说明
200 OK	WikiContract	Wiki 已成功更新。 标头 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	模拟用户帐户

示例

ApiManagementUpdateApiWiki

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default?api-version=2024-05-01


{
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      }
    ]
  }
}

示例响应

状态代码:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default",
  "type": "Microsoft.ApiManagement/service/apis/wikis",
  "name": "default",
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      }
    ]
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
WikiContract	Wiki 属性
WikiDocumentationContract	Wiki 文档详细信息。
WikiUpdateContract	Wiki 更新合同详细信息。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

WikiContract

Object

Wiki 属性

名称	类型	说明
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.documents	WikiDocumentationContract[]	此 Wiki 中包含的集合 Wiki 文档。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WikiDocumentationContract

Object

Wiki 文档详细信息。

名称	类型	说明
documentationId	string	文档标识符

WikiUpdateContract

Object

Wiki 更新合同详细信息。

名称	类型	说明
properties.documents	WikiDocumentationContract[]	此 Wiki 中包含的集合 Wiki 文档。