Latest API version for some Azure resources not supported by AzAPI

[suchi271]

I am facing this issue when using AzAPI provider version 2.0.1 (latest) with latest API version type in portal. For example - When trying to deploy Azure AI Studio Hub using terraform. Even though the AzAPI provider is pointing to the latest version, and I am using the latest stable API version type (2024-10-01) as per portal attached in the screenshot, I am getting blocked in the plan stage saying invalid configuration.

[ms-henglu]

Hi @suchi271 ,

Thank you for taking time to report this issue!

The azapi has an embedded type system. The 2024-10-01 was not included in the v2.0.1 release, but it will be included in the next release. You can disable the validation using the feature flag schema_validation_enabled = false within the resource block.

[suchi271]

Hi @ms-henglu ,

Thank you for your attention to this issue. I have a few questions.... May I get the list of API versions that are included as part of v2.0.1? So that I can restrict the upper limit for all products getting this error.

Also, if my understanding is right as part of every AzAPI version update there is a list of API versions that it can support, so 2024-10-01 will most probably be supported by future 2.x versions but not by anything under it.... Requesting you to confirm this as well :)

[ms-henglu]

Hi @suchi271 ,

Yes, it's highly recommended to use the AzAPI VSCode extension with same version v2.0.1, it provides auto-completion for the available types and api-versions. It also has more other features could help you get started with AzAPI provider.
https://marketplace.visualstudio.com/items?itemName=azapi-vscode.azapi

Also, if my understanding is right as part of every AzAPI version update there is a list of API versions that it can support, so 2024-10-01 will most probably be supported by future 2.x versions but not by anything under it.... Requesting you to confirm this as well :)

Yes, future versions will keep supporting more api-versions. Actually the type system is only used to do an enhanced validation, you could disable the feature and continue using a version that is not supported in AzAPI yet.

[suchi271]

Thanks for the above clarifications and the VSCode extension @ms-henglu , Is there an official documentation somewhere with all AzAPI versions and its list of supported API versions?

[ms-henglu]

This is the official doc: https://learn.microsoft.com/en-us/azure/templates/microsoft.aad/domainservices?pivots=deployment-language-arm-template, but the docs might not be updated in time.

[suchi271]

@ms-henglu Can you help me with this as well -> So, this is in case of another product - Subnet that I am deploying through AzAPI. The latest API version for subnet is 2024-03-01, The deployment works when I use AzAPI v2.0.1, but not with v1.15.0, I get the below error -

So are latest API versions only supported by latest AzAPI versions (2.0.1 in our case) ?

[ms-henglu]

Hi @suchi271 - This case is not about API Versions. The subnet is deployed with v2.x, the terraform state is not compatible with azapi v1.x version.