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

Question

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

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?

Answer 1

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.