documentation

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

Overview

Name	documentation
Type	Resource
Id	azure.api_management.documentation

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
content	string	Markdown documentation content.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	documentation title.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	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.
content	string	Markdown documentation content.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	documentation title.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, documentation_id, subscription_id		Gets the details of the Documentation specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists all Documentations of the API Management service instance.
create_or_update	insert	resource_group_name, service_name, documentation_id, subscription_id		Creates a new Documentation or updates an existing one.
update	update	resource_group_name, service_name, documentation_id, subscription_id		Updates the details of the Documentation for an API specified by its identifier.
create_or_update	replace	resource_group_name, service_name, documentation_id, subscription_id		Creates a new Documentation or updates an existing one.
delete	delete	resource_group_name, service_name, documentation_id, subscription_id		Deletes the specified Documentation from an API.
get_entity_tag	exec	resource_group_name, service_name, documentation_id, subscription_id		Gets the entity state (Etag) version of the Documentation by its identifier.

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
documentation_id	string	Documentation identifier. Must be unique in the current API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | eq | contains |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the Documentation specified by its identifier.

SELECT
id,
name,
content,
systemData,
title,
type
FROM azure.api_management.documentation
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND documentation_id = '{{ documentation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists all Documentations of the API Management service instance.

SELECT
id,
name,
content,
systemData,
title,
type
FROM azure.api_management.documentation
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.documentation (
properties,
resource_group_name,
service_name,
documentation_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ documentation_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: documentation
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the documentation resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the documentation resource.
  - name: documentation_id
    value: "{{ documentation_id }}"
    description: Required parameter for the documentation resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the documentation resource.
  - name: properties
    description: |
      Markdown Documentation details.
    value:
      title: "{{ title }}"
      content: "{{ content }}"

UPDATE examples

update

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

UPDATE azure.api_management.documentation
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND documentation_id = '{{ documentation_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a new Documentation or updates an existing one.

REPLACE azure.api_management.documentation
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND documentation_id = '{{ documentation_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified Documentation from an API.

DELETE FROM azure.api_management.documentation
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND documentation_id = '{{ documentation_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the Documentation by its identifier.

EXEC azure.api_management.documentation.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@documentation_id='{{ documentation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;