Azure API Management Tag

This page shows how to write Terraform and Azure Resource Manager for API Management Tag and write them securely.

azurerm_api_management_tag (Terraform)

The Tag in API Management can be configured in Terraform with the resource name azurerm_api_management_tag. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • api_management_id - (Required) The ID of the API Management. Changing this forces a new API Management Tag to be created.

  • name - (Required) The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.

  • display_name - (Optional) The display name of the API Management Tag. Defaults to the name.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the API Management Tag.

Explanation in Terraform Registry

Manages a API Management Tag.

Microsoft.ApiManagement/service/tags (Azure Resource Manager)

The service/tags in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/tags. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    Tag identifier. Must be unique in the current API Management service instance.

  • properties required
      • displayName required - string

        Tag name.

  • type required - string

Frequently asked questions

What is Azure API Management Tag?

Azure API Management Tag is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.