api_tag_description

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

Overview

Name	api_tag_description
Type	Resource
Id	azure.api_management.api_tag_description

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.
description	string	Description of the Tag.
displayName	string	Tag name.
externalDocsDescription	string	Description of the external resources describing the tag.
externalDocsUrl	string	Absolute URL of external resources describing the tag.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tagId	string	Identifier of the tag in the form of /tags/{tagId}.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

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.
description	string	Description of the Tag.
displayName	string	Tag name.
externalDocsDescription	string	Description of the external resources describing the tag.
externalDocsUrl	string	Absolute URL of external resources describing the tag.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tagId	string	Identifier of the tag in the form of /tags/{tagId}.
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, api_id, tag_description_id, subscription_id		Get Tag description in scope of API.
list_by_service	select	resource_group_name, service_name, api_id, subscription_id	$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	resource_group_name, service_name, api_id, tag_description_id, subscription_id		Create/Update tag description in scope of the Api.
create_or_update	replace	resource_group_name, service_name, api_id, tag_description_id, subscription_id		Create/Update tag description in scope of the Api.
delete	delete	resource_group_name, service_name, api_id, tag_description_id, subscription_id		Delete tag description for the Api.
get_entity_tag	exec	resource_group_name, service_name, api_id, tag_description_id, subscription_id		Gets the entity state version of the tag specified by its identifier.

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
api_id	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. 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
tag_description_id	string	Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$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

Get Tag description in scope of API.

SELECT
id,
name,
description,
displayName,
externalDocsDescription,
externalDocsUrl,
systemData,
tagId,
type
FROM azure.api_management.api_tag_description
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND tag_description_id = '{{ tag_description_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
description,
displayName,
externalDocsDescription,
externalDocsUrl,
systemData,
tagId,
type
FROM azure.api_management.api_tag_description
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_description (
properties,
resource_group_name,
service_name,
api_id,
tag_description_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ tag_description_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_tag_description
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_tag_description resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_tag_description resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_tag_description resource.
  - name: tag_description_id
    value: "{{ tag_description_id }}"
    description: Required parameter for the api_tag_description resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_tag_description resource.
  - name: properties
    description: |
      Properties supplied to Create TagDescription operation.
    value:
      description: "{{ description }}"
      externalDocsUrl: "{{ externalDocsUrl }}"
      externalDocsDescription: "{{ externalDocsDescription }}"

REPLACE examples

create_or_update

Create/Update tag description in scope of the Api.

REPLACE azure.api_management.api_tag_description
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND tag_description_id = '{{ tag_description_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete tag description for the Api.

DELETE FROM azure.api_management.api_tag_description
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND tag_description_id = '{{ tag_description_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state version of the tag specified by its identifier.

EXEC azure.api_management.api_tag_description.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@api_id='{{ api_id }}' --required, 
@tag_description_id='{{ tag_description_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;