Microsoft.ApiManagement service/apis/tagDescriptions 2021-04-01-preview

  • Article

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    externalDocsDescription: 'string'
    externalDocsUrl: 'string'
  }
}

Property values

service/apis/tagDescriptions

Name Description Value
name The resource name

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

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: apis
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

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": "2021-04-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 '2021-04-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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      externalDocsDescription = "string"
      externalDocsUrl = "string"
    }
  })
}

Property values

service/apis/tagDescriptions

Name Description Value
type The resource type "Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: apis
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