What apiVersion should be used to create Microsoft.ApiManagement service/properties resources via ARM templates?

Question

What apiVersion should be used to create Microsoft.ApiManagement service/properties resources via ARM templates?

Nicolas Louw 0

The Azure API management portal recommends updating the API management minimum API version to 2019-12-01 or higher. User's image

More detail is provided here: https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/api-version-retirement-sep-2023#required-action

We also recommend setting the Minimum API version in your API Management instance. Update your tools, scripts, and programs

ARM, Bicep, or Terraform templates - Update the template to use API version 2021-08-01 or later.

Unfortunately implementing this recommendation breaks our ARM deployment templates for API management as the maximum apiVersion supported for Microsoft.ApiManagement/service/properties appears to be 2019-01-01 as per https://learn.microsoft.com/en-us/azure/templates/microsoft.apimanagement/service/properties?pivots=deployment-language-arm-template#microsoftapimanagementserviceproperties-1

Is there a way to implement the recommendation while still supporting the automated deployment of Microsoft.ApiManagement/service/properties?

Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-17T06:17:52.2166667+00:00
Hi @Nicolas Louw ,

Welcome to Microsoft Q&A Platform!

To create Microsoft.ApiManagement/service/properties resources using ARM templates, the maximum supported API version is 2019-01-01, as stated in the Azure documentation. However, the Azure API Management portal suggests using a minimum API version of 2019-12-01 or higher for the overall API Management instance.

This discrepancy means that while you can set a minimum API version for the API Management instance, you may still have to use the older API version for the service/properties resource in your ARM templates. Unfortunately, due to this limitation, there is no straightforward way to implement the recommendation of using a higher API version while still supporting the automated deployment of Microsoft.ApiManagement/service/properties.

To help you better understand, kindly refer to the documentation below:

Test cases for ARM templates

I hope this helps! Let me know if you have any further questions or need additional assistance.
Nicolas Louw 0 Reputation points

2025-02-17T06:59:56.8133333+00:00

Copilot drew a similar conclusion.

As an workaround, prepared a PowerShell script to downgrade the minimum API version before deployment, then upgrade after. Unfortunately modifying an API management instance takes a while, so hopefully Microsoft will provide a better solution.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-19T09:37:42.97+00:00
Hi @Nicolas Louw ,

Thanks for your patience on this.

Currently the latest api version for "Microsoft.ApiManagement service/properties" is 2019-01-01 as called out in the documentation

Regarding the announcement it is suggested to update the api versions greater than '2021-08-01' and prior api versions will be retired. As I understand you are trying to create APIM, products, subscription etc., using the ARM or Bicep template currently using the latest '2024-06-01-preview' you can create the below list of resources.

In the above list we dont see Services/properties post creating the service via template can you try updating its api version using the powershell or rest api. Also in the retriment documentation, it is mentioned that if the Minimum api version in portal is grayed out you need to update it via rest api or through cli cmdlets only.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-20T07:19:28.02+00:00

Hi @Nicolas Louw ,

Just checking in to see if the information above was helpful. If you have any further updates on this issue, please feel free to post them here.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-21T08:29:58.3766667+00:00

Hi @Nicolas Louw ,

If you found the response helpful, please click Accept Answer and Yes for the provided answer. This will help other community members with similar issues find the solution more easily.
Nicolas Louw 0 Reputation points

2025-02-21T10:08:03.53+00:00

Thanks for the research, but unfortunately we are not able to update the supported API versions for Microsoft.ApiManagement/service/properties resources as that is controlled from the Microsoft end.

As mentioned previously, our current workaround is to downgrade the minimum API version for the API management instance to 2019-01-01 before deploying ARM templates for that instance, then upgrade the minimum API version again once the deployment is complete.

This is not really a great solution, as configuring API management this way can take 20-30 minutes. Until Microsoft introduces a new API version for Microsoft.ApiManagement/service/properties resources, I can't think of another way to resolve this discrepancy.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-27T06:22:32.14+00:00

Hi @Nicolas Louw ,

Just checking in to see if the information provided by Tom Kerkhove was helpful. If you have any further updates on this issue, please post them here.
Nicolas Louw 0 Reputation points

2025-02-27T06:46:09.7+00:00

Thanks Tom, we already create named values to store signatures to access Logic Apps via the API management instance, but my understanding was that "properties" were also required to make those values available to the inbound policy.

We use a rewrite-uri action with the logic app trigger url, and retrieve the signature with {{name_of_the_property}}.

I can't remember whether I tried that with {{name_of_the_namedvalue}} initially, but will give it another go.

I seem to recall my initial templates failed unless I provided a property in addition to the named value, but that was quite a while ago.
Tom Kerkhove 5 Reputation points Microsoft Employee

2025-02-27T06:51:43.6966667+00:00

I can't remember whether I tried that with {{name_of_the_namedvalue}} initially, but will give it another go.

This should work indeed! Property is not required and Named Values is its replacement
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-03-03T10:57:35.72+00:00

Hi @Nicolas Louw ,

Could you please provide an update on the status of the issue? If you have any further updates on this issue, please feel free to post them here.

1 answer

Your answer

Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-17T06:17:52.2166667+00:00

Hi @Nicolas Louw ,

Welcome to Microsoft Q&A Platform!

To create Microsoft.ApiManagement/service/properties resources using ARM templates, the maximum supported API version is 2019-01-01, as stated in the Azure documentation. However, the Azure API Management portal suggests using a minimum API version of 2019-12-01 or higher for the overall API Management instance.

This discrepancy means that while you can set a minimum API version for the API Management instance, you may still have to use the older API version for the service/properties resource in your ARM templates. Unfortunately, due to this limitation, there is no straightforward way to implement the recommendation of using a higher API version while still supporting the automated deployment of Microsoft.ApiManagement/service/properties.

To help you better understand, kindly refer to the documentation below:

Test cases for ARM templates

I hope this helps! Let me know if you have any further questions or need additional assistance.
Nicolas Louw 0 Reputation points

2025-02-17T06:59:56.8133333+00:00

Copilot drew a similar conclusion.

As an workaround, prepared a PowerShell script to downgrade the minimum API version before deployment, then upgrade after. Unfortunately modifying an API management instance takes a while, so hopefully Microsoft will provide a better solution.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-19T09:37:42.97+00:00

Hi @Nicolas Louw ,

Thanks for your patience on this.

Currently the latest api version for "Microsoft.ApiManagement service/properties" is 2019-01-01 as called out in the documentation

Regarding the announcement it is suggested to update the api versions greater than '2021-08-01' and prior api versions will be retired. As I understand you are trying to create APIM, products, subscription etc., using the ARM or Bicep template currently using the latest '2024-06-01-preview' you can create the below list of resources.

In the above list we dont see Services/properties post creating the service via template can you try updating its api version using the powershell or rest api. Also in the retriment documentation, it is mentioned that if the Minimum api version in portal is grayed out you need to update it via rest api or through cli cmdlets only.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-20T07:19:28.02+00:00

Hi @Nicolas Louw ,

Just checking in to see if the information above was helpful. If you have any further updates on this issue, please feel free to post them here.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-21T08:29:58.3766667+00:00

Hi @Nicolas Louw ,

If you found the response helpful, please click Accept Answer and Yes for the provided answer. This will help other community members with similar issues find the solution more easily.
Nicolas Louw 0 Reputation points

2025-02-21T10:08:03.53+00:00

Thanks for the research, but unfortunately we are not able to update the supported API versions for Microsoft.ApiManagement/service/properties resources as that is controlled from the Microsoft end.

As mentioned previously, our current workaround is to downgrade the minimum API version for the API management instance to 2019-01-01 before deploying ARM templates for that instance, then upgrade the minimum API version again once the deployment is complete.

This is not really a great solution, as configuring API management this way can take 20-30 minutes. Until Microsoft introduces a new API version for Microsoft.ApiManagement/service/properties resources, I can't think of another way to resolve this discrepancy.
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-02-27T06:22:32.14+00:00

Hi @Nicolas Louw ,

Just checking in to see if the information provided by Tom Kerkhove was helpful. If you have any further updates on this issue, please post them here.
Nicolas Louw 0 Reputation points

2025-02-27T06:46:09.7+00:00

Thanks Tom, we already create named values to store signatures to access Logic Apps via the API management instance, but my understanding was that "properties" were also required to make those values available to the inbound policy.

We use a rewrite-uri action with the logic app trigger url, and retrieve the signature with {{name_of_the_property}}.

I can't remember whether I tried that with {{name_of_the_namedvalue}} initially, but will give it another go.

I seem to recall my initial templates failed unless I provided a property in addition to the named value, but that was quite a while ago.
Tom Kerkhove 5 Reputation points Microsoft Employee

2025-02-27T06:51:43.6966667+00:00

I can't remember whether I tried that with {{name_of_the_namedvalue}} initially, but will give it another go.

This should work indeed! Property is not required and Named Values is its replacement
Shireesha Eeraboina 3,435 Reputation points Microsoft External Staff Moderator

2025-03-03T10:57:35.72+00:00

Hi @Nicolas Louw ,

Could you please provide an update on the status of the issue? If you have any further updates on this issue, please feel free to post them here.

Answer 1

Tom Kerkhove 5 Microsoft Employee

Properties were renamed to NamedValues which you should switch to instead: https://learn.microsoft.com/en-us/azure/templates/microsoft.apimanagement/2024-06-01-preview/service/namedvalues?pivots=deployment-language-arm-template

Share via

What apiVersion should be used to create Microsoft.ApiManagement service/properties resources via ARM templates?

1 answer

Your answer