Manages an API Management Group.
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_api_management" "example" {
name = "example-apim"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
publisher_name = "pub1"
publisher_email = "pub1@email.com"
sku_name = "Developer_1"
}
resource "azurerm_api_management_group" "example" {
name = "example-apimg"
resource_group_name = azurerm_resource_group.example.name
api_management_name = azurerm_api_management.example.name
display_name = "Example Group"
description = "This is an example API management group."
}
The following arguments are supported:
name
- (Required) The name of the API Management Group. Changing this forces a new resource to be created.
resource_group_name
- (Required) The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
api_management_name
- (Required) The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
display_name
- (Required) The display name of this API Management Group.
description
- (Optional) The description of this API Management Group.
external_id
- (Optional) The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant id>/groups/<group object id>
. Changing this forces a new resource to be created.
type
- (Optional) The type of this API Management Group. Possible values are custom
, external
and system
. Default is custom
. Changing this forces a new resource to be created.
In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the API Management Group.The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the API Management Group.update
- (Defaults to 30 minutes) Used when updating the API Management Group.read
- (Defaults to 5 minutes) Used when retrieving the API Management Group.delete
- (Defaults to 30 minutes) Used when deleting the API Management Group.API Management Groups can be imported using the resource id
, e.g.
terraform import azurerm_api_management_group.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/groups/example-apimg