Azure API Management Group

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

azurerm_api_management_group (Terraform)

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

Example Usage from GitHub

r-products-groups.tf#L1
resource "azurerm_api_management_group" "group" {
  for_each            = var.create_product_group_and_relationships ? toset(var.products) : []
  name                = each.key
  resource_group_name = var.resource_group_name
  api_management_name = azurerm_api_management.apim.name
  display_name        = each.key
main.tf#L13
resource "azurerm_api_management_group" "api_management_group" {
  for_each = {
    for group in var.groups :
    group.name => {
      name         = group.name
      display_name = group.display_name
product.tf#L12
resource "azurerm_api_management_group" "create_group" {
  name                = "iot-cameras"
  api_management_name = var.apim_name
  resource_group_name = var.rg_name
  display_name        = "IoT Camera Devices"
  description         = "Camera Sensors that will be taking pictures."
portal-users.tf#L13
resource "azurerm_api_management_group" "group"{
  for_each = { for apim_groups in var.apim_groups : apim_groups.name => apim_groups }
  api_management_name = var.apim_name
  resource_group_name = var.apim_resource_group
  name                = each.value.name
  display_name        = each.value.display_name
main.tf#L7
resource "azurerm_api_management_group" "this" {
  api_management_name = var.api_management_name
  description         = var.description
  display_name        = var.display_name
  external_id         = var.external_id
  name                = var.name
main.tf#L7
resource "azurerm_api_management_group" "this" {
  api_management_name = var.api_management_name
  description         = var.description
  display_name        = var.display_name
  external_id         = var.external_id
  name                = var.name
main.tf#L18
resource "azurerm_api_management_group" "people_group" {
    name                = "people-group"
    resource_group_name = data.azurerm_resource_group.rg.name
    api_management_name = data.azurerm_api_management.apim.name
    display_name        = "PeopleGroup"
    description         = "User have access to People information APIs"
mgmt-groups.tf#L5
resource "azurerm_api_management_group" "mydevelopers" {
  name                = "mydevelopers"
  resource_group_name = azurerm_resource_group.base.name
  api_management_name = azurerm_api_management.base.name
  display_name        = "MyDevelopers"
  description         = "Group for Internal Developers"
mgmt-groups.tf#L5
resource "azurerm_api_management_group" "mydevelopers" {
  name                = "mydevelopers"
  resource_group_name = azurerm_resource_group.base.name
  api_management_name = azurerm_api_management.base.name
  display_name        = "MyDevelopers"
  description         = "Group for Internal Developers"
mgmt-groups.tf#L5
resource "azurerm_api_management_group" "mydevelopers" {
  name                = "mydevelopers"
  resource_group_name = azurerm_resource_group.base.name
  api_management_name = azurerm_api_management.base.name
  display_name        = "MyDevelopers"
  description         = "Group for Internal Developers"

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

Explanation in Terraform Registry

Manages an API Management Group.

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

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

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

  • properties required
      • description optional - string

        Group description.

      • displayName required - string

        Group name.

      • externalId optional - string

        Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

      • type optional - string

        Group type.

  • type required - string

Frequently asked questions

What is Azure API Management Group?

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

For Terraform, the claranet/terraform-azurerm-api-management, pagopa/io-infrastructure-modules-new and techbunny/hybrid-network-lab source code examples are useful. See the Terraform Example section for further details.