api_tag_descriptions

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

Overview

Name	api_tag_descriptions
Type	Resource
Id	azure.api_management.api_tag_descriptions

Fields

vw_api_tag_descriptions

Name	Datatype	Description
description	text	field from the properties object
apiId	text	field from the properties object
display_name	text	field from the properties object
external_docs_description	text	field from the properties object
external_docs_url	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
tagDescriptionId	text	field from the properties object
tag_id	text	field from the properties object

api_tag_descriptions

Name	Datatype	Description
properties	object	TagDescription contract Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, resourceGroupName, serviceName, subscriptionId, tagDescriptionId	Get Tag description in scope of API
list_by_service	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	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	apiId, resourceGroupName, serviceName, subscriptionId, tagDescriptionId	Create/Update tag description in scope of the Api.
delete	DELETE	If-Match, apiId, resourceGroupName, serviceName, subscriptionId, tagDescriptionId	Delete tag description for the Api.

SELECT examples

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

vw_api_tag_descriptions

SELECT
description,
apiId,
display_name,
external_docs_description,
external_docs_url,
resourceGroupName,
serviceName,
subscriptionId,
tagDescriptionId,
tag_id
FROM azure.api_management.vw_api_tag_descriptions
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_tag_descriptions

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.api_tag_descriptions (
apiId,
resourceGroupName,
serviceName,
subscriptionId,
tagDescriptionId,
properties
)
SELECT 
'{{ apiId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ tagDescriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: externalDocsUrl
          value: string
        - name: externalDocsDescription
          value: string

DELETE example

Deletes the specified api_tag_descriptions resource.

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