Documentation - Update

服務:

API Management

API 版本:

2024-05-01

更新其識別碼所指定 API 的文件詳細數據。

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

URI 參數

名稱	位於	必要	類型	Description
documentationId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	文件識別碼。 目前 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)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-Match	True	string	實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

要求本文

名稱	類型	Description
properties.content	string	Markdown 文件內容。
properties.title	string	檔標題。

回應

名稱	類型	Description
200 OK	DocumentationContract	已成功更新檔。 標題 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	模擬您的用戶帳戶

範例

ApiManagementUpdateDocumentation

範例要求

HTTP

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

{
  "properties": {
    "title": "Title updated",
    "content": "content updated"
  }
}

範例回覆

狀態碼:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/documentations",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "title": "Title updated",
    "content": "content updated"
  }
}

定義

名稱	Description
DocumentationContract	Markdown 文件詳細數據。
DocumentationUpdateContract	檔更新合約詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

DocumentationContract

Object

Markdown 文件詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.content	string	Markdown 文件內容。
properties.title	string	檔標題。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

DocumentationUpdateContract

Object

檔更新合約詳細數據。

名稱	類型	Description
properties.content	string	Markdown 文件內容。
properties.title	string	檔標題。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。