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

Product Wiki - Create Or Update

为产品创建新的 Wiki 或更新现有 Wiki。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default?api-version=2022-08-01

URI 参数

名称 必需 类型 说明
productId
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.documents

WikiDocumentationContract[]

此 Wiki 中包含的集合 wiki 文档。

响应

名称 类型 说明
200 OK

WikiContract

Wiki 已成功更新。

标头

ETag: string

201 Created

WikiContract

已成功创建 Wiki。

标头

ETag: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementCreateProductWiki

示例请求

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

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

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default",
  "type": "Microsoft.ApiManagement/service/products/wikis",
  "name": "default",
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      },
      {
        "documentationId": "docId2"
      }
    ]
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default",
  "type": "Microsoft.ApiManagement/service/products/wikis",
  "name": "default",
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      },
      {
        "documentationId": "docId2"
      }
    ]
  }
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

WikiContract

Wiki 属性

WikiDocumentationContract

Wiki 文档详细信息。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

WikiContract

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

Wiki 文档详细信息。

名称 类型 说明
documentationId

string

文档标识符