Microsoft.ApiManagement service/apis/tagDescriptions template reference

Template format

To create a Microsoft.ApiManagement/service/apis/tagDescriptions resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "apiVersion": "2019-01-01",
  "properties": {
    "description": "string",
    "externalDocsUrl": "string",
    "externalDocsDescription": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/apis/tagDescriptions object

Name Type Required Value
name string Yes Tag identifier. Must be unique in the current API Management service instance.
type enum Yes Microsoft.ApiManagement/service/apis/tagDescriptions
apiVersion enum Yes 2019-01-01
properties object Yes Properties supplied to Create TagDescription operation. - TagDescriptionBaseProperties object

TagDescriptionBaseProperties object

Name Type Required Value
description string No Description of the Tag.
externalDocsUrl string No Absolute URL of external resources describing the tag.
externalDocsDescription string No Description of the external resources describing the tag.