client_application_product_link

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

Overview

Name	client_application_product_link
Type	Resource
Id	azure.api_management.client_application_product_link

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.
productId	string	The unique resource identifier of the Product. Required.
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".

list_by_client_applications

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.
productId	string	The unique resource identifier of the Product. Required.
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, client_application_id, client_application_product_link_id, subscription_id		Gets the product link for the client application.
list_by_client_applications	select	resource_group_name, service_name, client_application_id, subscription_id	$top, $skip	Lists a collection of product links associated with the specified client application.
create	insert	resource_group_name, service_name, client_application_id, client_application_product_link_id, subscription_id		Adds an Product to the specified Client Application via link.
delete	delete	resource_group_name, service_name, client_application_id, client_application_product_link_id, subscription_id		Deletes the specified Product from the specified client application.

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
client_application_id	string	Client Application identifier. Must be unique in the current API Management service instance. Required.
client_application_product_link_id	string	Client Application Product Link 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
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the product link for the client application.

SELECT
id,
name,
productId,
systemData,
type
FROM azure.api_management.client_application_product_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND client_application_id = '{{ client_application_id }}' -- required
AND client_application_product_link_id = '{{ client_application_product_link_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_client_applications

Lists a collection of product links associated with the specified client application.

SELECT
id,
name,
productId,
systemData,
type
FROM azure.api_management.client_application_product_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND client_application_id = '{{ client_application_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create

Adds an Product to the specified Client Application via link.

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

Manifest

# Description fields are for documentation purposes
- name: client_application_product_link
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the client_application_product_link resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the client_application_product_link resource.
  - name: client_application_id
    value: "{{ client_application_id }}"
    description: Required parameter for the client_application_product_link resource.
  - name: client_application_product_link_id
    value: "{{ client_application_product_link_id }}"
    description: Required parameter for the client_application_product_link resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the client_application_product_link resource.
  - name: properties
    description: |
      Client application - product link entity contract properties.
    value:
      productId: "{{ productId }}"

DELETE examples

delete

Deletes the specified Product from the specified client application.

DELETE FROM azure.api_management.client_application_product_link
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND client_application_id = '{{ client_application_id }}' --required
AND client_application_product_link_id = '{{ client_application_product_link_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;