Top / Microsoft Azure / Azure API Management / API Version Set

Azure API Management API Version Set

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

terraform-logo

Review your .tf file for Azure best practices

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

azurerm_api_management_api_version_set (Terraform)

The API Version Set in API Management can be configured in Terraform with the resource name azurerm_api_management_api_version_set. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

sampleMainApim.tf#L28
resource "azurerm_api_management_api_version_set" "roomsversionset" {
  name                = "rooms"
  api_management_name = azurerm_api_management.apiapim.name
  resource_group_name = azurerm_api_management.apiapim.resource_group_name
  display_name        = "api Rooms API"
  versioning_scheme   = "Segment"
apim.tf#L125
resource "azurerm_api_management_api_version_set" "apim_hub_spid_login_api" {
  name                = format("%s-spid-login-api", var.env_short)
  resource_group_name = azurerm_resource_group.rg_api.name
  api_management_name = module.apim.name
  display_name        = "SPID"
  versioning_scheme   = "Segment"
main.tf#L1
resource "azurerm_api_management_api_version_set" "api_version_set" {
  count               = length(var.api_version_set)
  api_management_name = element(var.api_management_name, lookup(var.api_version_set[count.index], "api_management_id"))
  display_name        = lookup(var.api_version_set[count.index], "display_name")
  name                = lookup(var.api_version_set[count.index], "name")
  resource_group_name = var.resource_group_name
apim_checkout.tf#L37
resource "azurerm_api_management_api_version_set" "checkout_payments_api" {
  count = var.checkout_enabled ? 1 : 0

  name                = format("%s-checkout-payments-api", var.env_short)
  resource_group_name = azurerm_resource_group.rg_api.name
  api_management_name = module.apim.name
main.tf#L7
resource "azurerm_api_management_api_version_set" "this" {
  api_management_name = var.api_management_name
  description         = var.description
  display_name        = var.display_name
  name                = var.name
  resource_group_name = var.resource_group_name
main.tf#L7
resource "azurerm_api_management_api_version_set" "this" {
  api_management_name = var.api_management_name
  description         = var.description
  display_name        = var.display_name
  name                = var.name
  resource_group_name = var.resource_group_name
main.tf#L85
resource "azurerm_api_management_api_version_set" "main" {
  name                = "api-management-demo-apim-versions"
  resource_group_name = azurerm_resource_group.main.name
  api_management_name = azurerm_api_management.main.name
  display_name        = "API Versions"
  versioning_scheme   = "Query"
apim.tf#L81
resource "azurerm_api_management_api_version_set" "fermium_v2" {
  name                = "6151ac05e139cd62d9f6c772"
  resource_group_name = azurerm_resource_group.rg.name
  api_management_name = azurerm_api_management.apim.name
  display_name        = "fermium"
  versioning_scheme   = "Segment"
main.tf#L4
resource "azurerm_api_management_api_version_set" "versionset" {
  name                = var.api_versionset_name
  resource_group_name = var.apim_resource_group
  api_management_name = var.apim_name
  display_name        = var.api_versionset_displayname
  versioning_scheme   = "Segment"
01_apim_api.tf#L39
resource "azurerm_api_management_api_version_set" "userregistry_api" {
  name                = format("%s-userregistry-api", var.env_short)
  resource_group_name = module.apim.resource_group_name
  api_management_name = module.apim.name
  display_name        = local.apim_userregistry_api.display_name
  versioning_scheme   = "Segment"

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

>> from Terraform Registry

Explanation in Terraform Registry

Manages an API Version Set within an API Management Service.

>> from Terraform Registry

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

The service/apiVersionSets in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/apiVersionSets. 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

    Api Version Set identifier. Must be unique in the current API Management service instance.

  • properties required
      • description optional - string

        Description of API Version Set.

      • displayName required - string

        Name of API Version Set

      • versionHeaderName optional - string

        Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

      • versioningScheme required - string

        An value that determines where the API Version identifier will be located in a HTTP request.

      • versionQueryName optional - string

        Name of query parameter that indicates the API Version if versioningScheme is set to query.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management API Version Set?

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

Where can I find the example code for the Azure API Management API Version Set?

For Terraform, the awaldow/openapi-to-terraform, pagopa/selfcare-infra and mikamakusa/terraform source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents