Forum Discussion

kasunsjc's avatar
kasunsjc
Iron Contributor
Feb 20, 2017

ARM Templates (API Versions)

Hi All,

 

I have question regarding ARM templates API versions. I notice that when I create some resources I have to specify different API Versions for them. Is there any common API version we can apply ? because sometimes its so cumbersome to use different API versions for different resources.

 

Thanks

API Management
azure
  • Kristian Nese's avatar
    Kristian Nese
    May 28, 2017

    Hi Kasun!

    Excellent question!

     

    For ARM templates, you must specify an API version for every resource type you will deploy. This API version corresponds to a version of REST API operations that are released by the resource provider (Microsoft.Compute/virtualMachines is the resource provider and namespace for virtual machines, Microsoft.Storage/storageAccounts is the resource provider and namespace for storage and storage accounts - as examples)

    Whenever a resource provider enables new features, it releases a new version of the REST API.

    In order for you to leverage new features, you must then use the new API version.

     

    Now, for you to know which API version to use, you can run the following PowerShell cmdlet to retrieve this info, for a selected resource provider:

     

    ((Get-AzureRmResourceProvider -ProviderNamespace Microsoft.Web).ResourceTypes | Where-Object ResourceTypeName -eq sites).ApiVersions

     

    Thanks!

     

  • Christian Forjahn's avatar
    Christian Forjahn
    Brass Contributor
    Apr 01, 2017
    I am also interested in that topic. Failing deployments because of wrong api versions is not state of the art any more
  • Kristian Nese's avatar
    Kristian Nese
    Icon for Microsoft rankMicrosoft
    May 28, 2017

    Hi Kasun!

    Excellent question!

     

    For ARM templates, you must specify an API version for every resource type you will deploy. This API version corresponds to a version of REST API operations that are released by the resource provider (Microsoft.Compute/virtualMachines is the resource provider and namespace for virtual machines, Microsoft.Storage/storageAccounts is the resource provider and namespace for storage and storage accounts - as examples)

    Whenever a resource provider enables new features, it releases a new version of the REST API.

    In order for you to leverage new features, you must then use the new API version.

     

    Now, for you to know which API version to use, you can run the following PowerShell cmdlet to retrieve this info, for a selected resource provider:

     

    ((Get-AzureRmResourceProvider -ProviderNamespace Microsoft.Web).ResourceTypes | Where-Object ResourceTypeName -eq sites).ApiVersions

     

    Thanks!

     

    • kasunsjc's avatar
      kasunsjc
      Iron Contributor
      Jul 31, 2017

      Hi Kristian,

       

      Thanks for the solution suggested, but in my openion Azure team should improve this to use less APIs versions for different resource deployment.

       

      Thanks 

  • EricStarker's avatar
    EricStarker
    Icon for Community Manager rankCommunity Manager
    Mar 28, 2017

    Great question! We're looking into this and will try to get an answer for you. 

    • kasunsjc's avatar
      kasunsjc
      Iron Contributor
      Apr 03, 2017

      Cool hope we can see result in near future.