ApiTagDescription

class ApiTagDescription : KotlinCustomResource

Manages an API Tag Description within an API Management Service.

Example Usage

resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:apimanagement:Service
name: example
properties:
name: example-apim
location: ${example.location}
resourceGroupName: ${example.name}
publisherName: My Company
publisherEmail: company@terraform.io
skuName: Developer_1
exampleApi:
type: azure:apimanagement:Api
name: example
properties:
name: example-api
resourceGroupName: ${example.name}
apiManagementName: ${exampleService.name}
revision: '1'
displayName: Example API
path: example
protocols:
- https
import:
contentFormat: swagger-link-json
contentValue: https://raw.githubusercontent.com/hashicorp/terraform-provider-azurerm/refs/heads/main/internal/services/apimanagement/testdata/api_management_api_swagger.json
exampleTag:
type: azure:apimanagement:Tag
name: example
properties:
apiManagementId: ${exampleService.id}
name: example-Tag
exampleApiTagDescription:
type: azure:apimanagement:ApiTagDescription
name: example
properties:
apiTagId: ${exampleTag.id}
description: This is an example description
externalDocsUrl: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs
externalDocsDescription: This is an example external docs description

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.ApiManagement: 2022-08-01

Import

API Management API Schema's can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/apiTagDescription:ApiTagDescription example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/tagDescriptions/tagDescriptionId1

Properties

Link copied to clipboard
val apiTagId: Output<String>

The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.

Link copied to clipboard
val description: Output<String>?

The description of the Tag.

Link copied to clipboard

The description of the external documentation resources describing the tag.

Link copied to clipboard

The URL of external documentation resources describing the tag.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>