Updating the module and library version

The avm-ptn-alz Terraform module, and its associated provider will be updated from time to time. Similarly, the policy library will also be updated with new features and bug fixes. Unlike previously, the module and the policy library are now decoupled, and can be updated independently.

To update the policy library, you must set the library_references configuration in the provider. Each provider release will have a default value, which will be the latest version of the ALZ policy library at the time of the release. To find the default value, you can check the provider documentation.

To update the policy library, you can set the library_references configuration to the desired version:

provider "alz" {
  library_references = [
    {
      path = "platform/alz",
      tag  = "2025.01.0"
    }
  ]
}

Then run a terraform plan to see the changes that will be applied.

If you have a local library, you may have a alz_library_metadata.json file in the root. If this file contains dependencies, you should update any dependent libraries here.

In line with the library versioning approach, there may be breaking changes on any year or month change. Patch releases will not contain breaking changes. We try to ensure that the changes are apply-able with Terraform, without manual intervention required.

Over time, the module will be updated with additional features and bug fixes. If you wish to update the module, you can simply update the version in the module source:

module "alz" {
  source = "Azure/avm-prn-alz/azurerm"
  version = "0.10.0"

  # ... other configuration
}

Then run a terraform plan to see the changes that will be applied.

The module may require an update to the provider. Ensure that the default value for library_references hasn’t changed and update it if necessary.