Skip to content

Commit dedac2c

Browse files
website: v0.15 Upgrade Guide entry for Azure Backend arguments
Terraform v0.15 includes the conclusion of the deprecation cycle for some renamed arguments in the "azure" backend. We missed this on the first draft of the upgrade guide because this change arrived along with various other more innocuous updates and so we didn't spot it during our change review.
1 parent 035d164 commit dedac2c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

website/upgrade-guides/0-15.html.markdown

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Upgrade guide sections:
5252
* [Commands Accepting a Configuration Directory Argument](#commands-accepting-a-configuration-directory-argument)
5353
* [Microsoft Windows Terminal Support](#microsoft-windows-terminal-support)
5454
* [Other Minor Command Line Behavior Changes](#other-minor-command-line-behavior-changes)
55+
* [Azure Backend `arm_`-prefixed Arguments](#azure-backend-removed-arguments)
5556

5657
## Sensitive Output Values
5758

@@ -493,3 +494,44 @@ cleanup of obsolete features and improved consistency:
493494
494495
If you are using `-force` in an automated call to `terraform destroy`,
495496
change to using `-auto-approve` instead.
497+
498+
## Azure Backend Removed Arguments
499+
500+
In an earlier release the `azure` backend changed to remove the `arm_` prefix
501+
from a number of the configuration arguments:
502+
503+
| Old Name | New Name |
504+
|-----------------------|-------------------|
505+
| `arm_client_id` | `client_id` |
506+
| `arm_client_secret` | `client_secret` |
507+
| `arm_subscription_id` | `subscription_id` |
508+
| `arm_tenant_id` | `tenant_id` |
509+
510+
The old names were previously deprecated, but we've removed them altogether
511+
in Terraform v0.15 in order to conclude that deprecation cycle.
512+
513+
If you have a backend configuration using the old names then you may see
514+
errors like the following when upgrading to Terraform v0.15:
515+
516+
```
517+
518+
│ Error: Invalid backend configuration argument
519+
520+
│ The backend configuration argument "arm_client_id" given on
521+
│ the command line is not expected for the selected backend type.
522+
523+
```
524+
525+
If you see errors like this, rename the arguments in your backend configuration
526+
as shown in the table above and then run the following to re-initialize your
527+
backend configuration:
528+
529+
```
530+
terraform init -reconfigure
531+
```
532+
533+
The `-reconfigure` argument instructs Terraform to just replace the old
534+
configuration with the new configuration directly, rather than offering to
535+
migrate the latest state snapshots from the old to the new configuration.
536+
Migration would not be appropriate in this case because the old and new
537+
configurations are equivalent and refer to the same remote objects.

0 commit comments

Comments
 (0)