api_tag_descriptions

Creates, updates, deletes, gets or lists an api_tag_descriptions resource.

Overview

Name	api_tag_descriptions
Type	Resource
Id	azure.api_management.api_tag_descriptions

Fields

The following fields are returned by SELECT queries:

get

Gets the description of the tag specified by its identifier in scope if the Api.

Name	Datatype	Description
properties	object	TagDescription entity contract properties.

list_by_service

The operation returns a collection of tagDescriptions associated with the Api entity.

Name	Datatype	Description
properties	object	TagDescription entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, apiId, tagDescriptionId, subscriptionId		Get Tag description in scope of API
list_by_service	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip	Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations
create_or_update	insert	resourceGroupName, serviceName, apiId, tagDescriptionId, subscriptionId	If-Match	Create/Update tag description in scope of the Api.
delete	delete	resourceGroupName, serviceName, apiId, tagDescriptionId, If-Match, subscriptionId		Delete tag description for the Api.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
apiId	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
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.
tagDescriptionId	string	Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | 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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Get Tag description in scope of API

SELECT
properties
FROM azure.api_management.api_tag_descriptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND tagDescriptionId = '{{ tagDescriptionId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

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

INSERT examples

create_or_update

Create/Update tag description in scope of the Api.

INSERT INTO azure.api_management.api_tag_descriptions (
data__properties,
resourceGroupName,
serviceName,
apiId,
tagDescriptionId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apiId }}',
'{{ tagDescriptionId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: api_tag_descriptions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_tag_descriptions resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_tag_descriptions resource.
    - name: apiId
      value: string
      description: Required parameter for the api_tag_descriptions resource.
    - name: tagDescriptionId
      value: string
      description: Required parameter for the api_tag_descriptions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_tag_descriptions resource.
    - name: properties
      value: object
      description: |
        Properties supplied to Create TagDescription operation.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Delete tag description for the Api.

DELETE FROM azure.api_management.api_tag_descriptions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND tagDescriptionId = '{{ tagDescriptionId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;