Top / Microsoft Azure / Azure API Management / Product Group

Azure API Management Product Group

This page shows how to write Terraform and Azure Resource Manager for API Management Product Group 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_product_group (Terraform)

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

Example Usage from GitHub

main.tf#L51
resource "azurerm_api_management_product_group" "people_group_people_std_product" {
    product_id          = azurerm_api_management_product.apim_product_std.product_id
    group_name          = azurerm_api_management_group.people_group.name
    api_management_name = data.azurerm_api_management.apim.name
    resource_group_name = data.azurerm_resource_group.rg.name
}
main.tf#L7
resource "azurerm_api_management_product_group" "this" {
  api_management_name = var.api_management_name
  group_name          = var.group_name
  product_id          = var.product_id
  resource_group_name = var.resource_group_name
r-products-groups.tf#L21
resource "azurerm_api_management_product_group" "product_group" {
  for_each            = var.create_product_group_and_relationships ? toset(var.products) : []
  product_id          = each.key
  resource_group_name = var.resource_group_name
  api_management_name = azurerm_api_management.apim.name
  group_name          = each.key
products.tf#L13
resource "azurerm_api_management_product_group" "product_group" {
  for_each = { for apim_product_group in var.apim_product_group : apim_product_group.product_id => apim_product_group }
  api_management_name   = var.apim_name
  resource_group_name   = var.apim_resource_group
  product_id            = each.value.product_id
  group_name            = each.value.group_name
product.tf#L20
resource "azurerm_api_management_product_group" "access_control" {
  product_id          = azurerm_api_management_product.injestion.product_id
  group_name          = azurerm_api_management_group.create_group.name
  api_management_name = var.apim_name
  resource_group_name = var.rg_name
}
main.tf#L7
resource "azurerm_api_management_product_group" "this" {
  api_management_name = var.api_management_name
  group_name          = var.group_name
  product_id          = var.product_id
  resource_group_name = var.resource_group_name
main.tf#L22
resource "azurerm_api_management_product_group" "this" {
  for_each = var.groups

  product_id          = azurerm_api_management_product.this.product_id
  resource_group_name = var.resource_group_name
  api_management_name = var.api_management_name
product.tf#L12
resource "azurerm_api_management_product_group" "access_control_groups" {
  for_each            = toset(var.product_access_control_groups)
  product_id          = azurerm_api_management_product.product.product_id
  group_name          = each.value
  api_management_name = var.api_mgmt_name
  resource_group_name = var.api_mgmt_rg
product-myfirstproduct.tf#L21
resource "azurerm_api_management_product_group" "mydevelopers" {
  product_id          = azurerm_api_management_product.mydevelopers.product_id
  group_name          = azurerm_api_management_group.mydevelopers.name
  api_management_name = azurerm_api_management.base.name
  resource_group_name = azurerm_resource_group.base.name
}
product-myfirstproduct.tf#L21
resource "azurerm_api_management_product_group" "mydevelopers" {
  product_id          = azurerm_api_management_product.mydevelopers.product_id
  group_name          = azurerm_api_management_group.mydevelopers.name
  api_management_name = azurerm_api_management.base.name
  resource_group_name = azurerm_resource_group.base.name
}

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 Management Product Assignment to a Group.

>> from Terraform Registry

Microsoft.ApiManagement/service/products/groups/groupId (Azure Resource Manager)

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

Example Usage from GitHub

An example could not be found in GitHub.

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management Product Group?

Azure API Management Product Group 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 Product Group?

For Terraform, the NewSignature/apim-training, kevinhead/azurerm and claranet/terraform-azurerm-api-management 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