api_wikis

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

Overview

Name	api_wikis
Type	Resource
Id	azure.api_management.api_wikis

Fields

vw_api_wikis

Name	Datatype	Description
apiId	text	field from the properties object
documents	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

api_wikis

Name	Datatype	Description
properties	object	Wiki contract details

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	Gets the details of the Wiki for an API specified by its identifier.
list	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	Gets the wikis for an API specified by its identifier.
create_or_update	INSERT	apiId, resourceGroupName, serviceName, subscriptionId	Creates a new Wiki for an API or updates an existing one.
delete	DELETE	If-Match, apiId, resourceGroupName, serviceName, subscriptionId	Deletes the specified Wiki from an API.
update	UPDATE	If-Match, apiId, resourceGroupName, serviceName, subscriptionId	Updates the details of the Wiki for an API specified by its identifier.

SELECT examples

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

vw_api_wikis

SELECT
apiId,
documents,
resourceGroupName,
serviceName,
subscriptionId
FROM azure.api_management.vw_api_wikis
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_wikis

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: documents
          value:
            - - name: documentationId
                value: string

UPDATE example

Updates a api_wikis resource.

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

DELETE example

Deletes the specified api_wikis resource.

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