Microsoft.ApiManagement service/apis/tagDescriptions

ARM template resource definition

The service/apis/tagDescriptions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

service/apis/tagDescriptions

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/apis/tagDescriptions'
apiVersion The resource api version '2023-05-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
properties Properties supplied to Create TagDescription operation. TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

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