Microsoft.ApiManagement service/apis/tagDescriptions 2020-06-01-preview

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": "2020-06-01-preview",
  "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 description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
type enum Yes tagDescriptions
-or-
Microsoft.ApiManagement/service/apis/tagDescriptions

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01-preview
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.