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
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
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
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."
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
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
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
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"
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"
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"
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"
Parameters
-
api_management_name
required - string -
description
optional - string -
display_name
required - string -
external_id
optional - string -
id
optional computed - string -
name
required - string -
resource_group_name
required - string -
type
optional - string -
timeouts
single block
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 - stringname
required - stringGroup identifier. Must be unique in the current API Management service instance.
properties
requireddescription
optional - stringGroup description.
displayName
required - stringGroup name.
externalId
optional - stringIdentifier 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 - stringGroup 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.