product_wikis

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

Overview

Name	product_wikis
Type	Resource
Id	azure.api_management.product_wikis

Fields

vw_product_wikis

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

product_wikis

Name	Datatype	Description
properties	object	Wiki contract details

Methods

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

SELECT examples

Gets the details of the Wiki for a Product specified by its identifier.

vw_product_wikis

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

product_wikis

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.product_wikis (
productId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ productId }}',
'{{ 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 product_wikis resource.

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

DELETE example

Deletes the specified product_wikis resource.

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