workspace_product_api_links

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

Overview

Name	workspace_product_api_links
Type	Resource
Id	azure.api_management.workspace_product_api_links

Fields

vw_workspace_product_api_links

Name	Datatype	Description
apiLinkId	text	field from the properties object
api_id	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
workspaceId	text	field from the properties object

workspace_product_api_links

Name	Datatype	Description
properties	object	Product-API link entity properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiLinkId, productId, resourceGroupName, serviceName, subscriptionId, workspaceId	Gets the API link for the product.
list_by_product	SELECT	productId, resourceGroupName, serviceName, subscriptionId, workspaceId	Lists a collection of the API links associated with a product.
create_or_update	INSERT	apiLinkId, productId, resourceGroupName, serviceName, subscriptionId, workspaceId	Adds an API to the specified product via link.
delete	DELETE	apiLinkId, productId, resourceGroupName, serviceName, subscriptionId, workspaceId	Deletes the specified API from the specified product.

SELECT examples

Lists a collection of the API links associated with a product.

vw_workspace_product_api_links

SELECT
apiLinkId,
api_id,
productId,
resourceGroupName,
serviceName,
subscriptionId,
workspaceId
FROM azure.api_management.vw_workspace_product_api_links
WHERE productId = '{{ productId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

workspace_product_api_links

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.workspace_product_api_links (
apiLinkId,
productId,
resourceGroupName,
serviceName,
subscriptionId,
workspaceId,
properties
)
SELECT 
'{{ apiLinkId }}',
'{{ productId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: apiId
          value: string

DELETE example

Deletes the specified workspace_product_api_links resource.

/*+ delete */
DELETE FROM azure.api_management.workspace_product_api_links
WHERE apiLinkId = '{{ apiLinkId }}'
AND productId = '{{ productId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';