documentations

Creates, updates, deletes, gets or lists a documentations resource.

Overview

Name	documentations
Type	Resource
Id	azure.api_management.documentations

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Documentation entity.

Name	Datatype	Description
properties	object	Markdown Documentation details.

list_by_service

Paged Result response of Documentations.

Name	Datatype	Description
properties	object	Markdown Documentation details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, documentationId, subscriptionId		Gets the details of the Documentation specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists all Documentations of the API Management service instance.
create_or_update	insert	resourceGroupName, serviceName, documentationId, subscriptionId	If-Match	Creates a new Documentation or updates an existing one.
update	update	resourceGroupName, serviceName, documentationId, If-Match, subscriptionId		Updates the details of the Documentation for an API specified by its identifier.
delete	delete	resourceGroupName, serviceName, documentationId, If-Match, subscriptionId		Deletes the specified Documentation from an API.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	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.
documentationId	string	Documentation identifier. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq | contains |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the Documentation specified by its identifier.

SELECT
properties
FROM azure.api_management.documentations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND documentationId = '{{ documentationId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists all Documentations of the API Management service instance.

SELECT
properties
FROM azure.api_management.documentations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates a new Documentation or updates an existing one.

INSERT INTO azure.api_management.documentations (
data__properties,
resourceGroupName,
serviceName,
documentationId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ documentationId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: documentations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the documentations resource.
    - name: serviceName
      value: string
      description: Required parameter for the documentations resource.
    - name: documentationId
      value: string
      description: Required parameter for the documentations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the documentations resource.
    - name: properties
      value: object
      description: |
        Markdown Documentation details.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

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

UPDATE azure.api_management.documentations
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND documentationId = '{{ documentationId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the specified Documentation from an API.

DELETE FROM azure.api_management.documentations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND documentationId = '{{ documentationId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;