Policy: Azure > API Management > API Management Service > Tags > Template

The template is used to generate the keys and values for Azure API Management api management service.

Tags not defined in API Management Service Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

Targets

This policy targets the following resource types:

Azure > API Management > API Management Service

Primary Policy

This policy is used with the following primary policy:

Azure > API Management > API Management Service > Tags

Controls

Setting this policy configures this control:

Azure > API Management > API Management Service > Tags

Policy Specification

Default template	`{%- if $.defaultTags.value \| length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value \| dump \| safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}`
Default template input	`- \| { subscription { turbot { id } } } - \| { defaultTags: policyValue(uri:"tmod:@turbot/azure-apimanagement#/policy/types/apiManagementTagsTemplate" resourceId: "{{ $.subscription.turbot.id }}") { value } }`
Examples [YAML]	`foo: bar environment: prod` `- foo123: bar - environment: dev` `- cost-center: zz123 - delete-me: undefined`

Default template

{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}

Default template input

- |
  {
    subscription {
      turbot {
        id
      }
    }
  }
- |
  {
    defaultTags: policyValue(uri:"tmod:@turbot/azure-apimanagement#/policy/types/apiManagementTagsTemplate" resourceId: "{{ $.subscription.turbot.id }}") {
      value
    }
  }

Examples [YAML]

foo: bar
environment: prod

- foo123: bar
- environment: dev

- cost-center: zz123
- delete-me: undefined

In Your Workspace

Policy Settings by Type report

Developers

Category URI

tmod:@turbot/turbot#/control/categories/resourceTags

Policy Type URI

tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate

GraphQL

query policyType(id: "tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate") { … }

query policySettings(filter: "policyTypeId:'tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate'") { … }

query policyValues(filter: "policyTypeId:'tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate'") { … }

CLI

Get Policy Type

turbot graphql policy-type --id "tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate"

Get Policy Settings

turbot graphql policy-settings --filter "policyTypeId:tmod:@turbot/azure-apimanagement#/policy/types/apiManagementServiceTagsTemplate"