We're adopting Azure API Management Workspaces (Premium tier). I need a definitive answer on base path (API URL suffix) uniqueness when multiple workspaces are involved.
Scenario
Workspace A has an API with base path: /apples/api/
Workspace B (in the same APIM instance) needs to publish another API with the same base path: /apple/api/.
In Scenario 1, both workspaces would use the default/built-in gateway.
In Scenario 2, each workspace would use a separate workspace gateway (different gateway resources).
Question
- Is this allowed in any scenario?
- Does associating a different workspace gateway per workspace change the base path uniqueness rule?
- If it's not allowed, could you point to the Microsoft Learn article/section that states the service-wide uniqueness requirement (ie, that the API URL suffix must be unique across the entire APIM instance, independent of workspace and workspace gateways)?
What I understand so far (please confirm/correct):
Workspaces are management-plane isolation; APIs still publish through the same APIM service runtime and gateway surface.
Microsoft Learn-Workspaces in Azure API Management (overview of workspaces and workspace
gateways):
https://learn.microsoft.com/en-us/azure/api-management/workspaces-overview
The API path (URL suffix) is a unique identifier within the APIM service instance per the REST contract for creating/updating an API under a workspace:
Workspace Api-Create Or Update (see properties.path: "Relative URL, uniquely identifying this API
...within the API Management service instance.:
https://learn.microsoft.com/en-us/rest/api/apimanagement/workspace-api/create-or-update?view=rest-
Goal
apimanagement-2024-05-01
I need to give my teams a clear rule: can two workspaces (even on different workspace gateways) reuse the same base path on the same APIM instance, or is the API URL suffix globally unique across the instance?
Environment
APIM Premium (Workspaces GA)
Considering both built-in gateway and workspace gateways
CI/CD via laC (Terraform) that targets workspace resource paths
Thanks in advance for an official clarification and the precise doc reference.