Share via

Documentation - Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Updates the details of the Documentation for an API specified by its identifier.

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

URI Parameters

Name In Required Type Description
documentationId
 path True

string

Documentation identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Header

Name Required Type Description
If-Match True

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name Type Description
properties.content

string

Markdown documentation content.
properties.title

string

documentation title.

Responses

Name Type Description
200 OK

DocumentationContract

Documentation was successfully updated.

Headers

ETag: string
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementUpdateDocumentation

Sample request

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"
  }
}

Sample response

Status code:
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"
  }
}

Definitions

Name Description
DocumentationContract

Markdown documentation details.
DocumentationUpdateContract

Documentation update contract details.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

DocumentationContract

Markdown documentation details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.content

string

Markdown documentation content.
properties.title

string

documentation title.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DocumentationUpdateContract

Documentation update contract details.

Name Type Description
properties.content

string

Markdown documentation content.
properties.title

string

documentation title.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.