Azure API Management: can't create, list or use schemas

Wolfgang M 6

Hi, today I tried to create schemas for my API management API in order to be able to validate incoming requests against these schemas.
Unfortunately I can't create any schemas in the Azure Portal due to the error "Specified product name is already in use" that appears when I enter a schema name in the mask. No matter how random of a name I choose, it always shows this error.

Because I am anyway using Terraform to create my resources I didn't bother long to investigate this issue.
When I finished the implementation and tried to apply the changes I faced another strange error:

Error in element 'validate-content' on line 6, column 14: The schema pim does not exist.

Terraform was able to create the schema but I couldn't use it in a valide-content policy.
The schema, although being created by Terraform, didn't show up in the Azure Portal.

I investigated further and used https://learn.microsoft.com/en-us/rest/api/apimanagement/current-preview/api-schema/list-by-api to list all schemas for my API.
And there it was, my "pim" schema!

I went back to the Azure Portal where Schemas should be listed, opened the Browser console, and refreshed the page.
The request to list the Schemas that is sent to Azure is has this header set:

x-ms-path-query: /subscriptions/<my-subscription-id>/resourceGroups/<my-resource-group>/providers/Microsoft.ApiManagement/service/<my-api-management-service>/schemas?api-version=2021-04-01-preview&$top=20

This header compared to the path used in the above mentioned Azure Management Rest documentation is different:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas?api-version=2021-04-01-preview

The apis/{apiId} part is not in the request in the portal. I copied the request as a curl statement, added the apis/{apiId} part and it worked!

It seems like Azure devs really made a mistake here. It seems like that API Schemas are completely not usable right now. But how can this be? I'd guess many users are using this feature.

Anyone any ideas? Am I missing something?

Mike Urnun 9,821 Reputation points Microsoft Employee

2022-03-22T01:04:20.46+00:00
Hello @Wolfgang M - I wasn't able to reproduce the issue while using Portal for uploading the schemas and listing them.

If you're still hitting this issue, could you share your Terraform code that reproduces the issue consistently? As for the difference between REST endpoints and the absence of the api/{apiId} param, the current GA version has Global and API level schemas:

Global: https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/global-schema/list-by-service

API level: https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-schema/list-by-api
Wolfgang M 6 Reputation points

2022-03-22T07:43:35.55+00:00

Hi Mike!

Thanks for your response.

I didn't see the global schemas endpoint. Interestingly, I can see the schema when I query the api-schema endpoint but not the global-schema endpoint.
Querying the global schemas endpoint should also list the api-schemas?

Of course I can share my Terraform code: https://gist.github.com/wolfm89/309c1cc432a216488541b93c4705d1ba

I am not sure though if my Terraform code can be the reason. I cannot even create a schema in the Portal.
No matter what I enter in the name field, I get this error:
Wolfgang M 6 Reputation points

2022-03-28T13:05:37.79+00:00

@Mike Urnun did you have time to check my reply? I am still facing this issue. Thanks!
Mike Urnun 9,821 Reputation points Microsoft Employee

2022-03-28T22:53:01.63+00:00
Hey @Wolfgang M - Based on the screenshot you provided above, I think that this could be an issue unique to your APIM instance. As the next step, I recommend opening a support case for this issue and working with a support engineer (who has deeper insight into your environment) in a 1:1 setting to troubleshoot the root cause.

If your Azure subscription doesn't carry a support plan, I can help enable your subscription with a one-time free support plan for resolving this particular issue. If you'd like to proceed with this option, please send me an email at azcommunity at microsoft dotcom with the subject line of your email reading "attn:murnun" and the body of the email including the following info:

Your Azure Subscription ID

URL of this thread
Johansson, Marcus Benjamin 1 Reputation point

2022-04-04T14:51:19.167+00:00

Hi, I also encountered this problem when trying to create schemas in an instance of API Management.

The faulty instance had been created through ARM templates.
I then tried to deploy another API mgt. instance from the portal, and suddenly I could create schemas.

Turns out that the new instance had the Basic SKU pre-selected, while the faulty one used the Consumption tier SKU.
When I changed the initial API Management instance from Consumption to Basic, I could create validation schemas without issue.
I assume this is a bug of some sort.

Hope this helps!

Share via

Azure API Management: can't create, list or use schemas

Your answer