Skip to main content

Generate Terraform import blocks directly from a binary .plan file

Project description

generate-imports-from-plan

Generates Terraform import {} blocks directly from a binary .plan file — no terraform CLI, no provider plugins, no terraform init required.

Why?

terraform show -json does not expose all planned attribute values — computed fields like resource names and resource group names are missing from the JSON output. This tool reads the raw msgpack-encoded attributes directly from the binary plan, giving access to all values needed to construct Azure resource IDs.

For resources whose IDs are assigned at creation time (Entra ID resources, Azure role assignments), the tool calls the Azure CLI to look up the real ID interactively.

Resources whose ID depends on another resource in the same plan (e.g. azurerm_virtual_network_dns_servers needs the VNet ID, subnet associations need the subnet ID) are resolved automatically by reading the plan's HCL references — no CLI call needed. The correct subscription ID is determined per resource by following the azurerm provider chain through the config, so plans that span multiple subscriptions get the right ID on each resource.

Installation

uvx generate-imports-from-plan terraform.plan

Or install permanently:

uv tool install generate-imports-from-plan
generate-imports-from-plan terraform.plan

Requirements

  • Python 3.11+
  • uv (for uvx)
  • Azure CLI (az) — required for live resolution of Entra ID resources and Azure role assignments

Workflow

# 1. Generate plan
terraform plan -out terraform.plan

# 2. Generate import blocks. --out splits resolved blocks (imports.tf) from
#    unresolved ones (imports.tf.unresolved); re-running converges.
generate-imports-from-plan terraform.plan --out imports.tf

# 3. Fill in any placeholders from imports.tf.unresolved, move them into
#    imports.tf, then re-plan and apply
terraform plan -out terraform.plan
terraform apply terraform.plan

Without --out, import blocks go to stdout (pipe with > imports.tf); unresolved ones are emitted as commented blocks.

Interactive flow

The tool prompts per resource based on what it can derive:

  • Complete formula-based ID — emitted immediately, no prompt.
  • Cross-plan ID (depends on another resource in the plan) — resolved and emitted automatically, no prompt.
  • Entra ID resource or Azure role assignment — shows the az command it will run and asks confirmation.
  • Unresolvable ID — shows which attribute is computed and its HCL reference chain; emitted to the unresolved sink (sidecar with --out, commented block otherwise).
  • Unsupported import (e.g. azuread_application_password) — emits a comment block.

Use --auto-resolve for a fully autonomous run (runs every az lookup without asking), or --dry-run to skip az calls and resolve deterministically (formula + cross-plan) only.

Output

import {
  to = module.core.azurerm_resource_group.this
  id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-myapp-dev-we-01"
}

import {
  to = module.core.azuread_application.default["my-app"]
  id = "/applications/00000000-0000-0000-0000-000000000000"
}

# import not supported for azuread_application_password:
# module.core.azuread_application_password.default["my-app"]

Flags

Flag Description
--out FILE Write resolved blocks to FILE, unresolved to FILE.unresolved; re-running converges
--auto-resolve Run every Azure CLI resolve automatically, without prompting
--dry-run Skip Azure CLI calls; resolve with formula + cross-plan only (no prompts)
--skip-imported Skip resources that already have an import {} block in the config
--list Print address\tid pairs instead of HCL blocks
--list --powershell Output a PowerShell array literal of resource addresses
--target ADDR [ADDR ...] Only emit the specified addresses (other plan resources stay available as cross-plan resolution context)
--debug Dump all decoded attributes per resource

Adding a resource type

See docs/resolvers.md for how to add a formula, a cross-plan resolver, or a live resolver.

Quick formula example — extend _ID_FORMULAS in generate_imports/ids.py:

"azurerm_my_resource":
    lambda a, s: _arm(s, _str(a, "resource_group_name"),
                      "Microsoft.MyNamespace/myResources", _str(a, "name")),

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

generate_imports_from_plan-0.4.0.tar.gz (59.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

generate_imports_from_plan-0.4.0-py3-none-any.whl (27.9 kB view details)

Uploaded Python 3

File details

Details for the file generate_imports_from_plan-0.4.0.tar.gz.

File metadata

  • Download URL: generate_imports_from_plan-0.4.0.tar.gz
  • Upload date:
  • Size: 59.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for generate_imports_from_plan-0.4.0.tar.gz
Algorithm Hash digest
SHA256 1e05476c5e45f4771b6b9cbd5e36815817da4abf5862bfa115922f320bfb9da4
MD5 672db93792ccd676e5a642f986992c9e
BLAKE2b-256 3322b3e3359c1e800652679f87c1e830d9f4a9cb507e0b0cc96349e43abafc6d

See more details on using hashes here.

File details

Details for the file generate_imports_from_plan-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: generate_imports_from_plan-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 27.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for generate_imports_from_plan-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fb651ea55e013a7b89742679f267f019fb9b9aa0bd7731fb64e37c728d932f6
MD5 fb13ee8aaf3d4bbdfcce94448a19d57c
BLAKE2b-256 5ac138a8c34b72f883a525571287115a6e34332671a13a9cc66a8e7cdb717c9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page