Unlocking the Best of Azure with AzureRM and AzAPI Providers

With the latest release of AzAPI 2.0, Azure offers two powerful Terraform providers to meet your infrastructure needs: AzureRM and AzAPI. The key question is when should you use each? For Terraform users, especially those familiar with the AzureRM provider, this article provides a clear guide to some ideal scenarios for each. The recommendations provided in this post are provided jointly between HashiCorp and Microsoft. Click here to see HashiCorp’s blog post.

outline

At a high level, AzureRM provides a stable and well-tested layer on top of the Azure API. Handles the entire resource lifecycle (creation, update, deletion) while managing breaking changes.Ensures smooth operation. AzureRM is ideal for users looking for stability and simplicity. Configuration management.

AzAPI, on the other hand, is a lightweight wrapper around the Azure API, giving you direct early access to the latest Azure features. This allows faster adoption of new services or workarounds for AzureRM limitations, making it ideal for users who require cutting-edge functionality. Below we’ll look at the differences between the two providers and when to use each.

AzureRM: A proven, simplified approach

AzureRM abstracts complexity by managing Azure API versions on your behalf. Thanks to rigorous testing, the provider ensures that resources are fully compatible with each other and that configuration changes do not cause serious problems. If you use resources that don’t require constant updates or access to the latest API versions, AzureRM provides a more stable and simplified experience.

Key benefits of AzureRM:

• Automatic API versioning: AzureRM handles API version compatibility to make upgrades seamless.
• simplicity: Resource property names are intuitive (e.g. disk_size_in_gb and disk_size), reducing the need to frequently refer to Azure API documentation.
• comprehensive documentation: AzureRM provides extensive resources and examples for each service, making it easier to onboard and use them in your projects.

AzureRM is ideal for scenarios where you prioritize reliability, want to minimize complexity, and don’t need the latest features.

AzAPI: Access to cutting-edge features and Azure APIs

AzAPI, on the other hand, provides a thinner layer, giving you direct access to the latest Azure API versions as soon as they are released. that very suitable for Scenarios where you need quick access to a feature before it is fully supported in AzureRM.

Key benefits of AzAPI:

• Instant API access: AzAPI provides users with access to the latest API versions of Azure resources, allowing teams to use new Azure services and features faster.
• Update target resource: The azapi_update_resource function allows you to modify specific resource properties without upgrading the entire resource or provider.
• fine control: AzAPI provides resource versioning to give you more control over your infrastructure configuration. Custom retryable errors, HTTP headers, URL controls, and resource replacement definitions are a few other ways that AzAPI provides granular control.

AzAPI is recommended for scenarios where early access to new Azure features is important or when you need granular control over your infrastructure.

Documentation and Community Support

AzureRM has a more extensive collection of blog posts, community contributions, and official documentation. This makes it easier for new users to find examples and scale quickly.

AzAPI is a newer version, but it follows Azure’s API structure more closely, making it easier to understand for users familiar with Bicep or ARM templates.

Conclusion: When to Use Each Provider

Select AzureRM If you prioritize Stability, Simplicityand Automatic versioning. Best suited for teams that want to minimize the complexity of infrastructure management and don’t need immediate access to new Azure features.

Select AzAPI if you need State-of-the-art access You will need to use the latest Azure API or: Customize resource configuration Without waiting for AzureRM to update. Ideal for teams that need rapid innovation and granular control over API versions.

Both providers offerfirDelivering the best experience supported by Microsoft and HashiCorp adapted According to your needs. Additionally, the upcoming release of the Azure Terraform Migration Tool (aztfmigration), allowing you to easily adapt your approach as your infrastructure evolves.

We hope this guide helps you decide when to use AzureRM or AzAPI and helps you get the most out of Terraform and your Azure infrastructure.