Documentation - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Lists all Documentations of the API Management service instance.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
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.
$filter	query		string	\| Field \| Usage \| Supported operators \| Supported functions \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| eq \| contains \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	DocumentationCollection	Paged Result response of Documentations.
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

ApiManagementListApis

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test2",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test3",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    }
  ],
  "nextLink": ""
}

Definitions

Name	Description
DocumentationCollection	Paged Documentation list representation.
DocumentationContract	Markdown documentation details.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DocumentationCollection

Paged Documentation list representation.

Name	Type	Description
nextLink	string	Next page link if any.
value	DocumentationContract[]	Page values.

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"

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.

Share via