Skip to content
EOL Watch
Search itemsOpen menu

AzureBreaking change

Terraform AzAPI provider 2.0.1: breaking changes

Release date for Terraform AzAPI provider 2.0.1: 21 Oct 2024. Breaking changes listed in the release notes: 9.

Breaking since , 21 Oct 2024

What breaks

Breaking changes listed in the release notes:

  • azapi_resource, azapi_update_resource resources and data sources' output field defaults to the readonly fields when the response_export_values is not specified.
  • azapi_resource_list data source's output field defaults to the response when the response_export_values is not specified.
  • Provider field default_naming_prefix and default_naming_suffix are removed. Please specify the naming prefix and suffix in the resource's name field instead.
  • Provider field enable_hcl_output_for_data_source is removed. The output field in the data source is always in HCL format.
  • The azapi_resource's removing_special_chars field is removed. Please specify the name field and remove the special characters in the name field instead.
  • The ignore_body_changes field is removed. Please use the lifecyle.ignore_changes to ignore some properties when comparing the resource with its current state.
  • The body field now only accepts an HCL object. Please remove the jsonencode function when using the body field.
  • The output field now only exports an HCL object. Please remove the jsondecode function when using the output field.
  • The use_msi field now defaults to false, please set it to true explicitly if you want to authenticate using Managed Service Identity.

Who is affected

Affected versions

  • 2.0.1

What to do

  1. Give the provider a version constraint in the required_providers block. HashiCorp recommends a version constraint for every provider a module depends on.
  2. In a root module, also specify the maximum provider version, to avoid accidental upgrades to incompatible new versions. The ~> operator is a shorthand that allows the rightmost component of a version to increment. Do not use ~> or other maximum-version constraints in modules you intend to reuse across many configurations. Specify a minimum version there and let the root module manage the maximum version.
  3. Commit the dependency lock file to version control with the configuration, so that Terraform always installs the same provider versions.
  4. To adopt 2.0.1, change the version in the required_providers block and re-run terraform init. HashiCorp states that this upgrades the provider version in the lock file. Without a change, Terraform re-selects the version recorded in the lock file, even if a newer version has become available. With the -upgrade option, terraform init disregards the recorded selection and selects the newest available version matching the version constraint. The release notes list each breaking change.
  5. Review the changes Terraform made to the lock file in version control. If they are changes you made intentionally, send them through the usual code review process.

Replacement

Not stated by vendor.

Sources

Last checked against this source on .

azapibreaking changes by version

Found an error? Report it

The text on this page is drafted with AI assistance from the vendor's text, checked against the official source and approved by a person before it is published. How items are written

Last checked · Added · Changelog for this item