Skip to content

Unrecognized Resource API Version

Stephen Weatherford (MSFT) edited this page Oct 25, 2022 · 5 revisions

When authoring an Azure Resource Manager template, each Azure resource is validated against a known good resource schema. These schemas are created from the Azure REST specification, also known as the OpenAPI specs. Without a resource schema, the ARM Tools cannot validate the Azure resource and also cannot offer up IntelliSense.

For some Azure resource providers, the OpenAPI spec to resource schema process is automated. A full list of these resource providers can be found here. For others, the process is not yet automated and in many cases, a schema has not been generated for all possible resource versions.

What this means to you is that a template may be crafted with a known good resource version, however, the tools will throw a warning that the resource API version must be updated. The resource is also not validated. This is a good indication that a resource schema has not been generated.

Note also that the Azure Resource Manager Tools extension ships with a snapshot of available API versions. Therefore, it may be behind by a month or two, depending on the most recent update.

In the following image the Microsoft.Web/sites resource has an apiVersion of 2016-03-01 which is a valid version for this resource. However, because a resource schema has not been generated for this version, a warning is thrown, which suggests alternate versions to use.

An image where an Azure resource has an unrecognized API version

If you are ok with updating the resource apiVersion, select one of the alternates. Doing so will update the resource to a version with a known good schema and the tools will provide full validation and IntelliSense. If you are not ok with updating the apiVersion, please open an issue on the Azure Resource Schemas GitHub repository.

We are working hard to automate the process across all resource providers and apologize for any inconvenience.