documentations

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

Overview

Name	documentations
Type	Resource
Id	azure.api_management.documentations

Fields

vw_documentations

Name	Datatype	Description
content	text	field from the properties object
documentationId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
title	text	field from the properties object

documentations

Name	Datatype	Description
properties	object	Markdown documentation details.

Methods

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

SELECT examples

Lists all Documentations of the API Management service instance.

vw_documentations

SELECT
content,
documentationId,
resourceGroupName,
serviceName,
subscriptionId,
title
FROM azure.api_management.vw_documentations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

documentations

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

INSERT example

Use the following StackQL query and manifest file to create a new documentations resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.documentations (
documentationId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ documentationId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: title
          value: string
        - name: content
          value: string

UPDATE example

Updates a documentations resource.

/*+ update */
UPDATE azure.api_management.documentations
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND documentationId = '{{ documentationId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified documentations resource.

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