Manages an API Tag Description within an API Management Service.
provider "azurerm" {
features {}
}
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_api_management" "example" {
name = "example-apim"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
publisher_name = "My Company"
publisher_email = "company@terraform.io"
sku_name = "Developer_1"
}
resource "azurerm_api_management_api" "example" {
name = "example-api"
resource_group_name = azurerm_resource_group.example.name
api_management_name = azurerm_api_management.example.name
revision = "1"
display_name = "Example API"
path = "example"
protocols = ["https"]
import {
content_format = "swagger-link-json"
content_value = "http://conferenceapi.azurewebsites.net/?format=json"
}
}
resource "azurerm_api_management_tag" "example" {
api_management_id = azurerm_api_management.example.id
name = "example-Tag"
}
resource "azurerm_api_management_api_tag_description" "example" {
api_tag_id = azurerm_api_management_tag.example.id
description = "This is an example description"
external_docs_url = "https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs"
external_docs_description = "This is an example external docs description"
}
The following arguments are supported:
api_tag_id
- (Required) The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description
- (Optional) The description of the Tag.
external_documentation_url
- (Optional) The URL of external documentation resources describing the tag.
external_documentation_description
- (Optional) The description of the external documentation resources describing the tag.
In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the API Management API Schema.The timeouts
block allows you to
specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the API Management API Schema.update
- (Defaults to 30 minutes) Used when updating the API Management API Schema.read
- (Defaults to 5 minutes) Used when retrieving the API Management API Schema.delete
- (Defaults to 30 minutes) Used when deleting the API Management API Schema.API Management API Schema's can be imported using the resource id
, e.g.
terraform import azurerm_api_management_api_tag_description.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/tagDescriptions/tagDescriptionId1