api_wiki

Creates, updates, deletes, gets or lists an api_wiki resource.

Overview

Name	api_wiki
Type	Resource
Id	azure.api_management.api_wiki

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.
documents	array	Collection wiki documents included into this wiki.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, api_id, subscription_id		Gets the details of the Wiki for an API specified by its identifier.
create_or_update	insert	resource_group_name, service_name, api_id, subscription_id		Creates a new Wiki for an API or updates an existing one.
update	update	resource_group_name, service_name, api_id, subscription_id		Updates the details of the Wiki for an API specified by its identifier.
create_or_update	replace	resource_group_name, service_name, api_id, subscription_id		Creates a new Wiki for an API or updates an existing one.
delete	delete	resource_group_name, service_name, api_id, subscription_id		Deletes the specified Wiki from an API.
get_entity_tag	exec	resource_group_name, service_name, api_id, subscription_id		Gets the entity state (Etag) version of the Wiki for an API specified 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
api_id	string	API 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

SELECT examples

get

Gets the details of the Wiki for an API specified by its identifier.

SELECT
id,
name,
documents,
systemData,
type
FROM azure.api_management.api_wiki
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new Wiki for an API or updates an existing one.

INSERT INTO azure.api_management.api_wiki (
properties,
resource_group_name,
service_name,
api_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_wiki
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_wiki resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_wiki resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_wiki resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_wiki resource.
  - name: properties
    description: |
      Wiki details.
    value:
      documents:
        - documentationId: "{{ documentationId }}"

UPDATE examples

update

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

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

REPLACE examples

create_or_update

Creates a new Wiki for an API or updates an existing one.

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

DELETE examples

delete

Deletes the specified Wiki from an API.

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

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.

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