Support for API Management Workspaces

[alexwiese]

Is there an existing issue for this?

• I have searched the existing issues

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Add support for API Management Workspaces.

New or Affected Resource(s)/Data Source(s)

azurerm_api_management_workspace

Potential Terraform Configuration

resource "azurerm_api_management_workspace" "my_workspace" {
    api_management_name = "my-apim"
    resource_group_name = "my-rg"
    name = "my-workspace"
    description = "description"

}

# Deploy an API to a workspace
resource "azurerm_api_management_api" "api" {
  name                = "my-api"
  api_management_name = "my-apim"
  resource_group_name = "my-rg"
  workspace_id        = azurerm_api_management_workspace.my_workspace.id
}

References

https://learn.microsoft.com/en-us/azure/api-management/workspaces-overview

[heller-tobias]

Having workspaces for Azure API Management in Terraform would make managing and deploying APIs easier and faster. I fully support this feature request.

[christopher-pope]

Do we have any update on when workspaces will be supported.

[lahiruperamune]

We're eagerly awaiting this feature. Are there any updates? As a workaround, we're currently using azapi_resource, but it would be great to have an azurerm resource for this.

[didaskein]

Workspace are in GA now :-) https://azure.microsoft.com/en-us/updates/v2/workspaces-in-azure-api-management
I can't wait for this to be supported in Terraform ;)

[myn]

Waiting for this feature.

[Ravindra-R-reddy]

Much needed feature as workspaces is GA now.

[JackBruceShell]

#27937

New ticket opened so referenced.

This is much needed now since APIM Workspaces are now GA.

Thanks

[avendretter]

Hello there,

Any updates on this one? Are there any plans this in 2025?

[cmptscpeacock]

Also required. Please provide and update.

[avendretter]

G'Day folks,

I am a bit tired of waiting :D So I started to take it into my own hands and started working here: https://github.com/avendretter/terraform-provider-azurerm/tree/feat/APIM_workspaces
opened a WIP PR as well: #28574

if you feel like contributing, I am planning to sign up to the Slack for contributors this week.

[cmptscpeacock]

@avendretter Thanks. this will help. We are using azapi resource block for now but it should be TF really.

A quick FYI - MS have changed something in the last week so when you deploy a workspace gateway it will only work with a /24 subnet. Last week it was working fine with a /27 (the minimum requirement as per their docs) so waiting for them to fix this issue.

[JackBruceShell]

@avendretter this looks good!

What about the following resources as well? The below are usually the standard elements someone would need when creating a workspace.

Workspace Gateway
Workspace Gateway Connection
Workspace Groups
Workspace APIs
Workspace Products
Workspace Product API Link
Workspace API Operations
Workspace API Operation Policies

Do your changes include these or have the scope to include these as an extension to what you have already done?