product_api_links

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

Overview

Name	product_api_links
Type	Resource
Id	azure.api_management.product_api_links

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified API link entity.

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

list_by_product

The response body contains a collection of API link entities in the product.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, productId, apiLinkId, subscriptionId		Gets the API link for the product.
list_by_product	select	resourceGroupName, serviceName, productId, subscriptionId	$filter, $top, $skip	Lists a collection of the API links associated with a product.
create_or_update	insert	resourceGroupName, serviceName, productId, apiLinkId, subscriptionId		Adds an API to the specified product via link.
delete	delete	resourceGroupName, serviceName, productId, apiLinkId, subscriptionId		Deletes the specified API from the specified product.

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
apiLinkId	string	Product-API link identifier. Must be unique in the current API Management service instance.
productId	string	Product identifier. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

get

Gets the API link for the product.

SELECT
properties
FROM azure.api_management.product_api_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND productId = '{{ productId }}' -- required
AND apiLinkId = '{{ apiLinkId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_product

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

SELECT
properties
FROM azure.api_management.product_api_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND productId = '{{ productId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Adds an API to the specified product via link.

INSERT INTO azure.api_management.product_api_links (
data__properties,
resourceGroupName,
serviceName,
productId,
apiLinkId,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ productId }}',
'{{ apiLinkId }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: product_api_links
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the product_api_links resource.
    - name: serviceName
      value: string
      description: Required parameter for the product_api_links resource.
    - name: productId
      value: string
      description: Required parameter for the product_api_links resource.
    - name: apiLinkId
      value: string
      description: Required parameter for the product_api_links resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the product_api_links resource.
    - name: properties
      value: object
      description: |
        Product-API link entity contract properties.

DELETE examples

delete

Deletes the specified API from the specified product.

DELETE FROM azure.api_management.product_api_links
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND productId = '{{ productId }}' --required
AND apiLinkId = '{{ apiLinkId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;